Set-TssConfigurationLocalUserPassword - new command

thycotic-ps · Sep 1, 2021 · 7b6ab4b · 7b6ab4b
1 parent 7b3341a
commit 7b6ab4b
Show file tree

Hide file tree

Showing 4 changed files with 593 additions and 12 deletions.
diff --git a/docs/commands/configurations/Set-TssConfigurationLocalUserPassword.md b/docs/commands/configurations/Set-TssConfigurationLocalUserPassword.md
@@ -0,0 +1,317 @@
+# Set-TssConfigurationLocalUserPassword
+
+## SYNOPSIS
+Set Local User Password configuration options
+
+## SYNTAX
+
+```
+Set-TssConfigurationLocalUserPassword [-TssSession] <Session> [-PasswordHistory]
+ [-PasswordHistoryCount <Int32>] [-ResetForgottenPassword] [-PasswordExpiration] [-ExpirationDay <Int32>]
+ [-ExpirationHour <Int32>] [-ExpirationMinute <Int32>] [-MinimumPasswordAge] [-AgeDay <Int32>]
+ [-AgeHour <Int32>] [-AgeMinute <Int32>] [-RequireNumber] [-RequireSymbol] [-RequireUppercase]
+ [-RequireLowercase] [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+## DESCRIPTION
+Set Local User Password configuration options
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+Set-TssConfigurationLocalUserPassword -TssSession $session -PasswordHistory -PasswordHistoryCount 50
+```
+
+Enable Password History, keeping 50 passwords of history
+
+## PARAMETERS
+
+### -TssSession
+TssSession object created by New-TssSession for authentication
+
+```yaml
+Type: Session
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByValue)
+Accept wildcard characters: False
+```
+
+### -PasswordHistory
+Enable Password History
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -PasswordHistoryCount
+Number of passwords stored in history, defaults to All
+
+```yaml
+Type: Int32
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: 2147483647
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ResetForgottenPassword
+Allow users to reset forgotten passwords
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -PasswordExpiration
+Enable Local User password expiration
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ExpirationDay
+Expiration in days
+
+```yaml
+Type: Int32
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: 0
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ExpirationHour
+Expiration in hours
+
+```yaml
+Type: Int32
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: 0
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ExpirationMinute
+Expiration in minutes
+
+```yaml
+Type: Int32
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: 0
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -MinimumPasswordAge
+Enable minimum password age
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -AgeDay
+Age in days
+
+```yaml
+Type: Int32
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: 0
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -AgeHour
+Age in hours
+
+```yaml
+Type: Int32
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: 0
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -AgeMinute
+Age in minutes
+
+```yaml
+Type: Int32
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: 0
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -RequireNumber
+Require numbers in a password
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -RequireSymbol
+Require symbols in a password
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -RequireUppercase
+Require uppercase in a password
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -RequireLowercase
+Require lowercase in a password
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -WhatIf
+Shows what would happen if the cmdlet runs.
+The cmdlet is not run.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Confirm
+Prompts you for confirmation before running the cmdlet.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+## OUTPUTS
+
+## NOTES
+Requires TssSession object returned by New-TssSession
+
+## RELATED LINKS
+
+[https://thycotic-ps.github.io/thycotic.secretserver/commands/configurations/Set-TssConfigurationLocalUserPassword](https://thycotic-ps.github.io/thycotic.secretserver/commands/configurations/Set-TssConfigurationLocalUserPassword)
+
+[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/configurations/Set-TssConfigurationLocalUserPassword.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/configurations/Set-TssConfigurationLocalUserPassword.ps1)
+
diff --git a/src/Thycotic.SecretServer.psd1 b/src/Thycotic.SecretServer.psd1
@@ -3,7 +3,7 @@
 #
 # Generated by: Shawn Melton
 #
-# Generated on: 8/31/2021
+# Generated on: 9/1/2021
 #
 
 @{
@@ -137,17 +137,18 @@ FunctionsToExport = 'Add-TssEventPipeline', 'Add-TssFolderPermission',
                'Search-TssSecretPolicy', 'Search-TssSecretTemplate', 
                'Search-TssSystemLog', 'Search-TssUser', 'Search-TssWorkflowTemplate', 
                'Set-TssConfigurationAutoExport', 'Set-TssConfigurationGeneral', 
-               'Set-TssFolder', 'Set-TssSecret', 'Set-TssSecretExpiration', 
-               'Set-TssSecretField', 'Set-TssSecretPolicy', 
-               'Set-TssSecretRpcAssociated', 'Set-TssSecretRpcPrivileged', 
-               'Set-TssSecretSecurity', 'Set-TssSecretTemplate', 
-               'Show-TssCurrentUser', 'Start-TssConfigurationBackup', 
-               'Start-TssConfigurationSearchIndex', 'Start-TssDiscovery', 
-               'Start-TssSecretChangePassword', 'Start-TssSecretDependency', 
-               'Start-TssSecretHeartbeat', 'Stop-TssSecretChangePassword', 
-               'Test-TssFolderAction', 'Test-TssSdkClient', 'Test-TssSecretAction', 
-               'Test-TssSecretState', 'Test-TssSession', 'Test-TssVersion', 
-               'Unlock-TssUser', 'Update-TssFolder', 'Update-TssFolderPermission', 
+               'Set-TssConfigurationLocalUserPassword', 'Set-TssFolder', 
+               'Set-TssSecret', 'Set-TssSecretExpiration', 'Set-TssSecretField', 
+               'Set-TssSecretPolicy', 'Set-TssSecretRpcAssociated', 
+               'Set-TssSecretRpcPrivileged', 'Set-TssSecretSecurity', 
+               'Set-TssSecretTemplate', 'Show-TssCurrentUser', 
+               'Start-TssConfigurationBackup', 'Start-TssConfigurationSearchIndex', 
+               'Start-TssDiscovery', 'Start-TssSecretChangePassword', 
+               'Start-TssSecretDependency', 'Start-TssSecretHeartbeat', 
+               'Stop-TssSecretChangePassword', 'Test-TssFolderAction', 
+               'Test-TssSdkClient', 'Test-TssSecretAction', 'Test-TssSecretState', 
+               'Test-TssSession', 'Test-TssVersion', 'Unlock-TssUser', 
+               'Update-TssFolder', 'Update-TssFolderPermission', 
                'Update-TssGroupMember', 'Update-TssMetadataField', 
                'Update-TssMetadataSection', 'Update-TssSecret', 
                'Update-TssSecretAccessRequest', 'Update-TssSecretHook',