From 5d26d24396312aac9a41e9fb10cd6beab0c9c040 Mon Sep 17 00:00:00 2001 From: Kirill Nikolaev Date: Sun, 16 Jan 2022 18:15:18 +0200 Subject: [PATCH] Updates docs --- docs/Set-GPPUser.md | 101 +++++++++++++++++++++++++++++++++++--------- 1 file changed, 80 insertions(+), 21 deletions(-) diff --git a/docs/Set-GPPUser.md b/docs/Set-GPPUser.md index f67f556..fd59ea3 100644 --- a/docs/Set-GPPUser.md +++ b/docs/Set-GPPUser.md @@ -12,13 +12,28 @@ Sets properties of a user definition in a specified Group Policy object. ## SYNTAX +### ByGPOIdObjectUserMustChangePassword +``` +Set-GPPUser -InputObject -GPOId [-Context ] + [-Action ] [-NewName ] [-FullName ] [-Description ] + [-AccountDisabled ] [-AccountExpires ] [-UserMustChangePassword ] + [-Disable ] [-PassThru] [] +``` + +### ByGPONameObjectUserMustChangePassword +``` +Set-GPPUser -InputObject -GPOName [-Context ] + [-Action ] [-NewName ] [-FullName ] [-Description ] + [-AccountDisabled ] [-AccountExpires ] [-UserMustChangePassword ] + [-Disable ] [-PassThru] [] +``` + ### ByGPOIdObject ``` Set-GPPUser -InputObject -GPOId [-Context ] [-Action ] [-NewName ] [-FullName ] [-Description ] [-AccountDisabled ] [-AccountExpires ] [-PasswordNeverExpires ] - [-UserMayNotChangePassword ] [-UserMustChangePassword ] [-Disable ] [-PassThru] - [] + [-UserMayNotChangePassword ] [-Disable ] [-PassThru] [] ``` ### ByGPONameObject @@ -26,7 +41,22 @@ Set-GPPUser -InputObject -GPOId [-Context ] Set-GPPUser -InputObject -GPOName [-Context ] [-Action ] [-NewName ] [-FullName ] [-Description ] [-AccountDisabled ] [-AccountExpires ] [-PasswordNeverExpires ] - [-UserMayNotChangePassword ] [-UserMustChangePassword ] [-Disable ] [-PassThru] + [-UserMayNotChangePassword ] [-Disable ] [-PassThru] [] +``` + +### ByGPOIdItemNameUserMustChangePassword +``` +Set-GPPUser -Name -GPOId [-Context ] [-Action ] + [-NewName ] [-FullName ] [-Description ] [-AccountDisabled ] + [-AccountExpires ] [-UserMustChangePassword ] [-Disable ] [-PassThru] + [] +``` + +### ByGPONameItemNameUserMustChangePassword +``` +Set-GPPUser -Name -GPOName [-Context ] [-Action ] + [-NewName ] [-FullName ] [-Description ] [-AccountDisabled ] + [-AccountExpires ] [-UserMustChangePassword ] [-Disable ] [-PassThru] [] ``` @@ -35,7 +65,7 @@ Set-GPPUser -InputObject -GPOName [-Context ] Set-GPPUser -Name -GPOId [-Context ] [-Action ] [-NewName ] [-FullName ] [-Description ] [-AccountDisabled ] [-AccountExpires ] [-PasswordNeverExpires ] [-UserMayNotChangePassword ] - [-UserMustChangePassword ] [-Disable ] [-PassThru] [] + [-Disable ] [-PassThru] [] ``` ### ByGPONameItemName @@ -43,7 +73,23 @@ Set-GPPUser -Name -GPOId [-Context ] [-Action -GPOName [-Context ] [-Action ] [-NewName ] [-FullName ] [-Description ] [-AccountDisabled ] [-AccountExpires ] [-PasswordNeverExpires ] [-UserMayNotChangePassword ] - [-UserMustChangePassword ] [-Disable ] [-PassThru] [] + [-Disable ] [-PassThru] [] +``` + +### ByGPOIdItemLiteralNameUserMustChangePassword +``` +Set-GPPUser -LiteralName -GPOId [-Context ] [-Action ] + [-NewName ] [-FullName ] [-Description ] [-AccountDisabled ] + [-AccountExpires ] [-UserMustChangePassword ] [-Disable ] [-PassThru] + [] +``` + +### ByGPONameItemLiteralNameUserMustChangePassword +``` +Set-GPPUser -LiteralName -GPOName [-Context ] + [-Action ] [-NewName ] [-FullName ] [-Description ] + [-AccountDisabled ] [-AccountExpires ] [-UserMustChangePassword ] + [-Disable ] [-PassThru] [] ``` ### ByGPOIdItemLiteralName @@ -51,7 +97,7 @@ Set-GPPUser -Name -GPOName [-Context ] [-Action -GPOId [-Context ] [-Action ] [-NewName ] [-FullName ] [-Description ] [-AccountDisabled ] [-AccountExpires ] [-PasswordNeverExpires ] [-UserMayNotChangePassword ] - [-UserMustChangePassword ] [-Disable ] [-PassThru] [] + [-Disable ] [-PassThru] [] ``` ### ByGPONameItemLiteralName @@ -59,8 +105,23 @@ Set-GPPUser -LiteralName -GPOId [-Context ] [-Action Set-GPPUser -LiteralName -GPOName [-Context ] [-Action ] [-NewName ] [-FullName ] [-Description ] [-AccountDisabled ] [-AccountExpires ] [-PasswordNeverExpires ] - [-UserMayNotChangePassword ] [-UserMustChangePassword ] [-Disable ] [-PassThru] - [] + [-UserMayNotChangePassword ] [-Disable ] [-PassThru] [] +``` + +### ByGPOIdItemBuiltInUserUserMustChangePassword +``` +Set-GPPUser -BuiltInUser -GPOId [-Context ] + [-Action ] [-NewName ] [-FullName ] [-Description ] + [-AccountDisabled ] [-AccountExpires ] [-UserMustChangePassword ] + [-Disable ] [-PassThru] [] +``` + +### ByGPONameItemBuiltInUserUserMustChangePassword +``` +Set-GPPUser -BuiltInUser -GPOName [-Context ] + [-Action ] [-NewName ] [-FullName ] [-Description ] + [-AccountDisabled ] [-AccountExpires ] [-UserMustChangePassword ] + [-Disable ] [-PassThru] [] ``` ### ByGPOIdItemBuiltInUser @@ -68,8 +129,7 @@ Set-GPPUser -LiteralName -GPOName [-Context ] Set-GPPUser -BuiltInUser -GPOId [-Context ] [-Action ] [-NewName ] [-FullName ] [-Description ] [-AccountDisabled ] [-AccountExpires ] [-PasswordNeverExpires ] - [-UserMayNotChangePassword ] [-UserMustChangePassword ] [-Disable ] [-PassThru] - [] + [-UserMayNotChangePassword ] [-Disable ] [-PassThru] [] ``` ### ByGPONameItemBuiltInUser @@ -77,8 +137,7 @@ Set-GPPUser -BuiltInUser -GPOId [-Contex Set-GPPUser -BuiltInUser -GPOName [-Context ] [-Action ] [-NewName ] [-FullName ] [-Description ] [-AccountDisabled ] [-AccountExpires ] [-PasswordNeverExpires ] - [-UserMayNotChangePassword ] [-UserMustChangePassword ] [-Disable ] [-PassThru] - [] + [-UserMayNotChangePassword ] [-Disable ] [-PassThru] [] ``` ## DESCRIPTION @@ -166,7 +225,7 @@ Allows you to target your user definition to a system built-in user, instead of ```yaml Type: GPPItemUserSubAuthorityDisplay -Parameter Sets: ByGPOIdItemBuiltInUser, ByGPONameItemBuiltInUser +Parameter Sets: ByGPOIdItemBuiltInUserUserMustChangePassword, ByGPONameItemBuiltInUserUserMustChangePassword, ByGPOIdItemBuiltInUser, ByGPONameItemBuiltInUser Aliases: Accepted values: Administrator, Guest @@ -243,7 +302,7 @@ Specifies the ID of a GPO in which you want to search for users. It is a name of ```yaml Type: Guid -Parameter Sets: ByGPOIdObject, ByGPOIdItemName, ByGPOIdItemLiteralName, ByGPOIdItemBuiltInUser +Parameter Sets: ByGPOIdObjectUserMustChangePassword, ByGPOIdObject, ByGPOIdItemNameUserMustChangePassword, ByGPOIdItemName, ByGPOIdItemLiteralNameUserMustChangePassword, ByGPOIdItemLiteralName, ByGPOIdItemBuiltInUserUserMustChangePassword, ByGPOIdItemBuiltInUser Aliases: Required: True @@ -258,7 +317,7 @@ Specifies the name of a GPO in which you want to search for users. ```yaml Type: String -Parameter Sets: ByGPONameObject, ByGPONameItemName, ByGPONameItemLiteralName, ByGPONameItemBuiltInUser +Parameter Sets: ByGPONameObjectUserMustChangePassword, ByGPONameObject, ByGPONameItemNameUserMustChangePassword, ByGPONameItemName, ByGPONameItemLiteralNameUserMustChangePassword, ByGPONameItemLiteralName, ByGPONameItemBuiltInUserUserMustChangePassword, ByGPONameItemBuiltInUser Aliases: Required: True @@ -273,7 +332,7 @@ If you already have a user definition object in memory, which you want to write ```yaml Type: GPPItemUser -Parameter Sets: ByGPOIdObject, ByGPONameObject +Parameter Sets: ByGPOIdObjectUserMustChangePassword, ByGPONameObjectUserMustChangePassword, ByGPOIdObject, ByGPONameObject Aliases: Required: True @@ -288,7 +347,7 @@ Specifies the name of a user which you want to change. Does not support wildcard ```yaml Type: String -Parameter Sets: ByGPOIdItemLiteralName, ByGPONameItemLiteralName +Parameter Sets: ByGPOIdItemLiteralNameUserMustChangePassword, ByGPONameItemLiteralNameUserMustChangePassword, ByGPOIdItemLiteralName, ByGPONameItemLiteralName Aliases: Required: True @@ -303,7 +362,7 @@ Specifies the name of a user which you want to change. Supports wildcards. ```yaml Type: String -Parameter Sets: ByGPOIdItemName, ByGPONameItemName +Parameter Sets: ByGPOIdItemNameUserMustChangePassword, ByGPONameItemNameUserMustChangePassword, ByGPOIdItemName, ByGPONameItemName Aliases: Required: True @@ -348,7 +407,7 @@ Speficies that the password of the target account should not expire. ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ByGPOIdObject, ByGPONameObject, ByGPOIdItemName, ByGPONameItemName, ByGPOIdItemLiteralName, ByGPONameItemLiteralName, ByGPOIdItemBuiltInUser, ByGPONameItemBuiltInUser Aliases: Required: False @@ -363,7 +422,7 @@ Specifies that the target account should not be able to change its password by i ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ByGPOIdObject, ByGPONameObject, ByGPOIdItemName, ByGPONameItemName, ByGPOIdItemLiteralName, ByGPONameItemLiteralName, ByGPOIdItemBuiltInUser, ByGPONameItemBuiltInUser Aliases: Required: False @@ -378,7 +437,7 @@ Specifies that the target account must change its password at the next logon. ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ByGPOIdObjectUserMustChangePassword, ByGPONameObjectUserMustChangePassword, ByGPOIdItemNameUserMustChangePassword, ByGPONameItemNameUserMustChangePassword, ByGPOIdItemLiteralNameUserMustChangePassword, ByGPONameItemLiteralNameUserMustChangePassword, ByGPOIdItemBuiltInUserUserMustChangePassword, ByGPONameItemBuiltInUserUserMustChangePassword Aliases: Required: False