chore: update user in examples (#215)

tenthirtyam · web-flow · commit e662b989839c · 2024-08-20T09:56:34.000-04:00
Updates the user used in the the examples from the `administrator@vsphere.local` SSO account to the `admin@local` API account for consistency. An administrative SSO account can still be used if desired.

Signed-off-by: Ryan Johnson &lt;ryan.johnson@broadcom.com&gt;
diff --git a/VMware.CloudFoundation.PasswordManagement.psd1 b/VMware.CloudFoundation.PasswordManagement.psd1
@@ -3,14 +3,14 @@
 
 # Module manifest for module 'VMware.CloudFoundation.PasswordManagement
 # Generated by: Broadcom
-# Generated on: 2024-08-19
+# Generated on: 2024-08-20
 
 @{
     # Script module or binary module file associated with this manifest.
     RootModule        = '.\VMware.CloudFoundation.PasswordManagement.psm1'
 
     # Version number of this module.
-    ModuleVersion     = '1.8.3.1002'
+    ModuleVersion     = '1.8.3.1003'
 
     # ID used to uniquely identify this module
     GUID              = '34e5a0c7-6e6e-4f72-8b3c-1c28248f8ac9'
diff --git a/VMware.CloudFoundation.PasswordManagement.psm1 b/VMware.CloudFoundation.PasswordManagement.psm1
diff --git a/docs/documentation/functions/Publish-WsaDirectoryPasswordPolicy.md b/docs/documentation/functions/Publish-WsaDirectoryPasswordPolicy.md
@@ -31,39 +31,39 @@ The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` va
 ### Example 1
 
 ```powershell
-Publish-WsaDirectoryPasswordPolicy -server sfo-wsa01.sfo.rainpole.io -user admin -pass VMw@re1! -policy PasswordExpiration -allDomains
+Publish-WsaDirectoryPasswordPolicy -server sfo-wsa01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -policy PasswordExpiration -allDomains
 ```
 
 This example returns the password expiration policy for Workspace ONE Access Directory Users.
 
 ### Example 2
 
 ```powershell
-Publish-WsaDirectoryPasswordPolicy -server sfo-wsa01.sfo.rainpole.io -user admin -pass VMw@re1! -policy PasswordComplexity -allDomains
+Publish-WsaDirectoryPasswordPolicy -server sfo-wsa01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -policy PasswordComplexity -allDomains
 ```
 
 This example returns the password complexity policy for Workspace ONE Access Directory Users.
 
 ### Example 3
 
 ```powershell
-Publish-WsaDirectoryPasswordPolicy -server sfo-wsa01.sfo.rainpole.io -user admin -pass VMw@re1! -policy AccountLockout -allDomains
+Publish-WsaDirectoryPasswordPolicy -server sfo-wsa01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -policy AccountLockout -allDomains
 ```
 
 This example returns the account lockout policy for Workspace ONE Access Directory Users.
 
 ### Example 4
 
 ```powershell
-Publish-WsaDirectoryPasswordPolicy -server sfo-wsa01.sfo.rainpole.io -user admin -pass VMw@re1! -policy PasswordExpiration -allDomains -drift -reportPath "F:\Reporting" -policyFile "passwordPolicyConfig.json"
+Publish-WsaDirectoryPasswordPolicy -server sfo-wsa01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -policy PasswordExpiration -allDomains -drift -reportPath "F:\Reporting" -policyFile "passwordPolicyConfig.json"
 ```
 
 This example returns the password expiration policy for Workspace ONE Access Directory Users and compares the configuration against the `passwordPolicyConfig.json` file.
 
 ### Example 5
 
 ```powershell
-Publish-WsaDirectoryPasswordPolicy -server sfo-wsa01.sfo.rainpole.io -user admin -pass VMw@re1! -policy PasswordExpiration -allDomains -drift
+Publish-WsaDirectoryPasswordPolicy -server sfo-wsa01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -policy PasswordExpiration -allDomains -drift
 ```
 
 This example returns the password expiration policy for Workspace ONE Access Directory Users and compares the configuration against the product defaults.
diff --git a/docs/documentation/functions/Request-WsaAccountLockout.md b/docs/documentation/functions/Request-WsaAccountLockout.md
@@ -30,15 +30,15 @@ This example retrieves the account lockout policy for Workspace ONE Access insta
 ### Example 2
 
 ```powershell
-Request-WsaAccountLockout -server sfo-wsa01.sfo.rainpole.io -user admin -pass VMw@re1! -drift -reportPath "F:\Reporting" -policyFile "passwordPolicyConfig.json"
+Request-WsaAccountLockout -server sfo-wsa01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -drift -reportPath "F:\Reporting" -policyFile "passwordPolicyConfig.json"
 ```
 
 This example retrieves the local user password complexity policy for Workspace ONE Access and checks the configuration drift using the provided configuration JSON.
 
 ### Example 3
 
 ```powershell
-Request-WsaAccountLockout -server sfo-wsa01.sfo.rainpole.io -user admin -pass VMw@re1! -drift
+Request-WsaAccountLockout -server sfo-wsa01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -drift
 ```
 
 This example retrieves the local user password complexity policy for Workspace ONE Access and compares the configuration against the product defaults.
diff --git a/docs/documentation/functions/Request-WsaPasswordComplexity.md b/docs/documentation/functions/Request-WsaPasswordComplexity.md
@@ -30,15 +30,15 @@ This example retrieves the password complexity policy for Workspace ONE Access i
 ### Example 2
 
 ```powershell
-Request-WsaPasswordExpiration -server sfo-wsa01.sfo.rainpole.io -user admin -pass VMw@re1! -drift -reportPath "F:\Reporting" -policyFile "passwordPolicyConfig.json"
+Request-WsaPasswordExpiration -server sfo-wsa01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -drift -reportPath "F:\Reporting" -policyFile "passwordPolicyConfig.json"
 ```
 
 This example retrieves the password complexity policy for Workspace ONE Access instance sfo-wsa01 and checks the configuration drift using the provided configuration JSON.
 
 ### Example 3
 
 ```powershell
-Request-WsaPasswordExpiration -server sfo-wsa01.sfo.rainpole.io -user admin -pass VMw@re1! -drift
+Request-WsaPasswordExpiration -server sfo-wsa01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -drift
 ```
 
 This example retrieves the password complexity policy for Workspace ONE Access instance sfo-wsa01 and compares the configuration against the product defaults.
diff --git a/docs/documentation/functions/Request-WsaPasswordExpiration.md b/docs/documentation/functions/Request-WsaPasswordExpiration.md
@@ -30,15 +30,15 @@ This example retrieves the password expiration policy for Workspace ONE Access i
 ### Example 2
 
 ```powershell
-Request-WsaPasswordExpiration -server sfo-wsa01.sfo.rainpole.io -user admin -pass VMw@re1! -drift -reportPath "F:\Reporting" -policyFile "passwordPolicyConfig.json"
+Request-WsaPasswordExpiration -server sfo-wsa01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -drift -reportPath "F:\Reporting" -policyFile "passwordPolicyConfig.json"
 ```
 
 This example retrieves the password expiration policy for Workspace ONE Access instance sfo-wsa01.sfo.rainpole.io and checks the configuration drift using the provided configuration JSON.
 
 ### Example 3
 
 ```powershell
-Request-WsaPasswordExpiration -server sfo-wsa01.sfo.rainpole.io -user admin -pass VMw@re1! -drift
+Request-WsaPasswordExpiration -server sfo-wsa01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -drift
 ```
 
 This example retrieves the password expiration policy for Workspace ONE Access instance sfo-wsa01.sfo.rainpole.io and compares the configuration against the product defaults.
diff --git a/docs/documentation/functions/Update-WsaAccountLockout.md b/docs/documentation/functions/Update-WsaAccountLockout.md
@@ -22,7 +22,7 @@ The `Update-WsaAccountLockout` cmdlet configures the account lockout policy for
 ### Example 1
 
 ```powershell
-Update-WsaAccountLockout -server sfo-wsa01.sfo.rainpole.io -user admin -pass VMw@re1! -failures 5 -failureInterval 180 -unlockInterval 900
+Update-WsaAccountLockout -server sfo-wsa01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -failures 5 -failureInterval 180 -unlockInterval 900
 ```
 
 This example configures the account lockout policy for Workspace ONE Access.
diff --git a/docs/documentation/functions/Update-WsaPasswordComplexity.md b/docs/documentation/functions/Update-WsaPasswordComplexity.md
@@ -22,7 +22,7 @@ The `Update-WsaPasswordComplexity` cmdlet configures the password complexity pol
 ### Example 1
 
 ```powershell
-Update-WsaPasswordComplexity -server sfo-wsa01.sfo.rainpole.io -user admin -pass VMw@re1! -minLength 15 -minLowercase 1 -minUppercase 1 -minNumeric 1 -minSpecial 1 -maxIdenticalAdjacent 1 -maxPreviousCharacters 0 -history 5
+Update-WsaPasswordComplexity -server sfo-wsa01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -minLength 15 -minLowercase 1 -minUppercase 1 -minNumeric 1 -minSpecial 1 -maxIdenticalAdjacent 1 -maxPreviousCharacters 0 -history 5
 ```
 
 This example configures the password complexity policy for Workspace ONE Access.
diff --git a/docs/documentation/functions/Update-WsaPasswordExpiration.md b/docs/documentation/functions/Update-WsaPasswordExpiration.md
@@ -22,7 +22,7 @@ The `Update-WsaPasswordExpiration` cmdlet configures the password expiration pol
 ### Example 1
 
 ```powershell
-Update-WsaPasswordExpiration -server sfo-wsa01.sfo.rainpole.io -user admin -pass VMw@re1! -maxDays 999 -warnDays 14 -reminderDays 7 -tempPasswordHours 24
+Update-WsaPasswordExpiration -server sfo-wsa01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -maxDays 999 -warnDays 14 -reminderDays 7 -tempPasswordHours 24
 ```
 
 This example configures the password expiration policy for Workspace ONE Access.
