Skip to content

Commit d93f8cf

Browse files
committed
fix: change <...> to [...] for examples
Changes `<...>` to `[...]` for examples. Signed-off-by: Ryan Johnson <[email protected]>
1 parent fe6af5b commit d93f8cf

File tree

82 files changed

+487
-484
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+487
-484
lines changed

Diff for: VMware.CloudFoundation.PasswordManagement.psm1

+248-248
Large diffs are not rendered by default.

Diff for: docs/documentation/functions/Get-PasswordPolicyDefault.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,15 @@ This example returns the default password policy settings for the VMware Cloud F
4545
### Example 2
4646

4747
```powershell
48-
Get-PasswordPolicyDefault -generateJson -jsonFile <policy_file>.json -version '5.0.0.0'
48+
Get-PasswordPolicyDefault -generateJson -jsonFile [policy_file].json -version '5.0.0.0'
4949
```
5050

5151
This example creates a JSON file with the default password policy settings for the given version of VMware Cloud Foundation.
5252

5353
### Example 3
5454

5555
```powershell
56-
Get-PasswordPolicyDefault -generateJson -jsonFile <policy_file>.json -version '5.0.0.0' -force
56+
Get-PasswordPolicyDefault -generateJson -jsonFile [policy_file].json -version '5.0.0.0' -force
5757
```
5858

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

Diff for: docs/documentation/functions/Invoke-PasswordPolicyManager.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -27,39 +27,39 @@ The `Invoke-PasswordPolicyManager` generates a Password Policy Manager Report fo
2727
### Example 1
2828

2929
```powershell
30-
Invoke-PasswordPolicyManager -sddcManagerFqdn <sddc_manager_fqdn> -sddcManagerUser <admin_username> -sddcManagerPass <admin_password> -sddcRootPass <root_password> -reportPath <report_path> -darkMode -allDomains
30+
Invoke-PasswordPolicyManager -sddcManagerFqdn [sddc_manager_fqdn] -sddcManagerUser [admin_username] -sddcManagerPass [admin_password] -sddcRootPass [root_password] -reportPath [report_path] -darkMode -allDomains
3131
```
3232

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

3535
### Example 2
3636

3737
```powershell
38-
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>
38+
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]
3939
```
4040

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

4343
### Example 3
4444

4545
```powershell
46-
Invoke-PasswordPolicyManager -sddcManagerFqdn <sddc_manager_fqdn> -sddcManagerUser <admin_username> -sddcManagerPass <admin_password> -sddcRootPass <root_password> -reportPath <report_path> -darkMode -workloadDomain <workload_domain_name>
46+
Invoke-PasswordPolicyManager -sddcManagerFqdn [sddc_manager_fqdn] -sddcManagerUser [admin_username] -sddcManagerPass [admin_password] -sddcRootPass [root_password] -reportPath [report_path] -darkMode -workloadDomain [workload_domain_name]
4747
```
4848

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

5151
### Example 4
5252

5353
```powershell
54-
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
54+
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
5555
```
5656

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

5959
### Example 5
6060

6161
```powershell
62-
Invoke-PasswordPolicyManager -sddcManagerFqdn <sddc_manager_fqdn> -sddcManagerUser <admin_username> -sddcManagerPass <admin_password> -sddcRootPass <root_password> -reportPath <report_path> -darkMode -allDomains -drift
62+
Invoke-PasswordPolicyManager -sddcManagerFqdn [sddc_manager_fqdn] -sddcManagerUser [admin_username] -sddcManagerPass [admin_password] -sddcRootPass [root_password] -reportPath [report_path] -darkMode -allDomains -drift
6363
```
6464

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

Diff for: docs/documentation/functions/Invoke-PasswordRotationManager.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ The `Invoke-PasswordRotationManager` generates a Password Rotation Manager Repor
2727
### Example 1
2828

2929
```powershell
30-
Invoke-PasswordRotationManager -sddcManagerFqdn <sddc_manager_fqdn> -sddcManagerUser <admin_username> -sddcManagerPass <admin_password> -sddcRootPass <root_password> -reportPath <report_path> -darkMode -allDomains
30+
Invoke-PasswordRotationManager -sddcManagerFqdn [sddc_manager_fqdn] -sddcManagerUser [admin_username] -sddcManagerPass [admin_password] -sddcRootPass [root_password] -reportPath [report_path] -darkMode -allDomains
3131
```
3232

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

3535
### Example 2
3636

3737
```powershell
38-
Invoke-PasswordRotationManager -sddcManagerFqdn <sddc_manager_fqdn> -sddcManagerUser <admin_username> -sddcManagerPass <admin_password> -sddcRootPass <root_password> -reportPath <report_path> -darkMode -workloadDomain <workload_domain_name>
38+
Invoke-PasswordRotationManager -sddcManagerFqdn [sddc_manager_fqdn] -sddcManagerUser [admin_username] -sddcManagerPass [admin_password] -sddcRootPass [root_password] -reportPath [report_path] -darkMode -workloadDomain [workload_domain_name]
3939
```
4040

4141
This example runs a password rotation report for a specific Workload Domain within an SDDC Manager instance.

Diff for: docs/documentation/functions/Publish-AriaLocalUserPasswordPolicy.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -37,47 +37,47 @@ The cmdlet connects to the SDDC Manager using the -server, -user, and -pass valu
3737
### Example 1
3838

3939
```powershell
40-
Publish-AriaLocalUserPasswordPolicy -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -policy PasswordExpiration -allDomains
40+
Publish-AriaLocalUserPasswordPolicy -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -policy PasswordExpiration -allDomains
4141
```
4242

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

4545
### Example 2
4646

4747
```powershell
48-
Publish-AriaLocalUserPasswordPolicy -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -policy PasswordExpiration -workloadDomain <workload_domain_name>
48+
Publish-AriaLocalUserPasswordPolicy -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -policy PasswordExpiration -workloadDomain [workload_domain_name]
4949
```
5050

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

5353
### Example 3
5454

5555
```powershell
56-
Publish-AriaLocalUserPasswordPolicy -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -policy PasswordComplexity -allDomains
56+
Publish-AriaLocalUserPasswordPolicy -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -policy PasswordComplexity -allDomains
5757
```
5858

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

6161
### Example 4
6262

6363
```powershell
64-
Publish-AriaLocalUserPasswordPolicy -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -policy PasswordComplexity -workloadDomain <workload_domain_name>
64+
Publish-AriaLocalUserPasswordPolicy -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -policy PasswordComplexity -workloadDomain [workload_domain_name]
6565
```
6666

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

6969
### Example 5
7070

7171
```powershell
72-
Publish-AriaLocalUserPasswordPolicy -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -policy AccountLockout -allDomains
72+
Publish-AriaLocalUserPasswordPolicy -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -policy AccountLockout -allDomains
7373
```
7474

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

7777
### Example 6
7878

7979
```powershell
80-
Publish-AriaLocalUserPasswordPolicy -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -policy AccountLockout -workloadDomain <workload_domain_name>
80+
Publish-AriaLocalUserPasswordPolicy -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -policy AccountLockout -workloadDomain [workload_domain_name]
8181
```
8282

8383
This example returns password account lockout policy for all VMware Aria products for the management domain.

Diff for: docs/documentation/functions/Publish-EsxiPasswordPolicy.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -32,63 +32,63 @@ The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` va
3232
### Example 1
3333

3434
```powershell
35-
Publish-EsxiPasswordPolicy -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -policy PasswordExpiration -allDomains
35+
Publish-EsxiPasswordPolicy -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -policy PasswordExpiration -allDomains
3636
```
3737

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

4040
### Example 2
4141

4242
```powershell
43-
Publish-EsxiPasswordPolicy -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -policy PasswordExpiration -workloadDomain <workload_domain_name>
43+
Publish-EsxiPasswordPolicy -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -policy PasswordExpiration -workloadDomain [workload_domain_name]
4444
```
4545

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

4848
### Example 3
4949

5050
```powershell
51-
Publish-EsxiPasswordPolicy -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -policy PasswordComplexity -allDomains
51+
Publish-EsxiPasswordPolicy -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -policy PasswordComplexity -allDomains
5252
```
5353

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

5656
### Example 4
5757

5858
```powershell
59-
Publish-EsxiPasswordPolicy -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -policy PasswordComplexity -workloadDomain <workload_domain_name>
59+
Publish-EsxiPasswordPolicy -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -policy PasswordComplexity -workloadDomain [workload_domain_name]
6060
```
6161

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

6464
### Example 5
6565

6666
```powershell
67-
Publish-EsxiPasswordPolicy -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -policy AccountLockout -allDomains
67+
Publish-EsxiPasswordPolicy -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -policy AccountLockout -allDomains
6868
```
6969

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

7272
### Example 6
7373

7474
```powershell
75-
Publish-EsxiPasswordPolicy -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -policy AccountLockout -workloadDomain <workload_domain_name>
75+
Publish-EsxiPasswordPolicy -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -policy AccountLockout -workloadDomain [workload_domain_name]
7676
```
7777

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

8080
### Example 7
8181

8282
```powershell
83-
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
83+
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
8484
```
8585

8686
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.
8787

8888
### Example 8
8989

9090
```powershell
91-
Publish-EsxiPasswordPolicy -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -policy PasswordExpiration -workloadDomain <workload_domain_name> -drift
91+
Publish-EsxiPasswordPolicy -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -policy PasswordExpiration -workloadDomain [workload_domain_name] -drift
9292
```
9393

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

Diff for: docs/documentation/functions/Publish-NsxEdgeAccountLockout.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -32,31 +32,31 @@ The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` va
3232
### Example 1
3333

3434
```powershell
35-
Publish-NsxEdgeAccountLockout -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -allDomains
35+
Publish-NsxEdgeAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains
3636
```
3737

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

4040
### Example 2
4141

4242
```powershell
43-
Publish-NsxEdgeAccountLockout -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name>
43+
Publish-NsxEdgeAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name]
4444
```
4545

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

4848
### Example 3
4949

5050
```powershell
51-
Publish-NsxEdgeAccountLockout -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name> -drift -reportPath <report_path> -policyFile <policy_file>.json
51+
Publish-NsxEdgeAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name] -drift -reportPath [report_path] -policyFile [policy_file].json
5252
```
5353

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

5656
### Example 4
5757

5858
```powershell
59-
Publish-NsxEdgeAccountLockout -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name> -drift
59+
Publish-NsxEdgeAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name] -drift
6060
```
6161

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

Diff for: docs/documentation/functions/Publish-NsxEdgePasswordComplexity.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -32,31 +32,31 @@ The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` va
3232
### Example 1
3333

3434
```powershell
35-
Publish-NsxEdgePasswordComplexity -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -allDomains
35+
Publish-NsxEdgePasswordComplexity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains
3636
```
3737

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

4040
### Example 2
4141

4242
```powershell
43-
Publish-NsxEdgePasswordComplexity -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name>
43+
Publish-NsxEdgePasswordComplexity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name]
4444
```
4545

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

4848
### Example 3
4949

5050
```powershell
51-
Publish-NsxEdgePasswordComplexity -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name> -drift -reportPath <report_path> -policyFile <policy_file>.json
51+
Publish-NsxEdgePasswordComplexity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name] -drift -reportPath [report_path] -policyFile [policy_file].json
5252
```
5353

5454
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.
5555

5656
### Example 4
5757

5858
```powershell
59-
Publish-NsxEdgePasswordComplexity -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name> -drift
59+
Publish-NsxEdgePasswordComplexity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name] -drift
6060
```
6161

6262
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.

Diff for: docs/documentation/functions/Publish-NsxEdgePasswordExpiration.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -32,31 +32,31 @@ The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` va
3232
### Example 1
3333

3434
```powershell
35-
Publish-NsxEdgePasswordExpiration -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -allDomains
35+
Publish-NsxEdgePasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains
3636
```
3737

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

4040
### Example 2
4141

4242
```powershell
43-
Publish-NsxEdgePasswordExpiration -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name>
43+
Publish-NsxEdgePasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name]
4444
```
4545

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

4848
### Example 3
4949

5050
```powershell
51-
Publish-NsxEdgePasswordExpiration -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name> -drift -reportPath <report_path> -policyFile <policy_file>.json
51+
Publish-NsxEdgePasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name] -drift -reportPath [report_path] -policyFile [policy_file].json
5252
```
5353

5454
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.
5555

5656
### Example 4
5757

5858
```powershell
59-
Publish-NsxEdgePasswordExpiration -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name> -drift
59+
Publish-NsxEdgePasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name] -drift
6060
```
6161

6262
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.

0 commit comments

Comments
 (0)