Get-RDMUser
2024-10-28
Get-RDMUser
SYNOPSIS
Retrieve the list of available users.
SYNTAX
__AllParameterSets
Get-RDMUser [[-Name] <string>] [-CaseSensitive] [-ForcePromptAnswer <DialogResult[]>]
[<CommonParameters>]
ALIASES
This cmdlet has the following aliases,
DESCRIPTION
Retrieve the list of available users for the current selected data source.
EXAMPLES
EXAMPLE 1
PS C:> Get-RDMUser
Retrieves the list of available user.
EXAMPLE 2
PS C:> $list = Get-RDMUser; $list[0]
Retrieves the list of available users and displays the first item.
EXAMPLE 3
PS C:> $list = Get-RDMUser; $list[1].Description = "New Description";Set-RDMUser $list[1]
Retrieves the list of available users, modify the name of the second user, update the user.
EXAMPLE 4
PS C:> $user = Get-RDMUser -Name MyUser; $user.UserInfo.UserProfile.Company = 'UsersCompany'; $user.UserInfo.UserProfile.Department = 'UsersDepartment'; $user.UserInfo.UserProfile.Address = '123 UsersAddress'; $user.UserInfo.UserProfile.Phone = '555-0100'; Set-RDMUser -User $user
Update information about the user MyUser.
PARAMETERS
-CaseSensitive
Case sensitive
Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-ForcePromptAnswer
Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values:
- Yes: Accept the prompt. Cover the OK and Automatic value.
- No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No.
- Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.
Type: System.Windows.Forms.DialogResult[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Name
User name
Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
Position: 1
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
RemoteDesktopManager.PowerShellModule.PSOutputObject.PSUserInfo
NOTES
For more information, type "Get-Help Get-RDMUser -detailed". For technical information, type "Get-Help Get-RDMUser -full".