Get-RDMSessionOTP

    2024-10-28

    Get-RDMSessionOTP

    SYNOPSIS

    Get the One Time Password from the specified session.

    SYNTAX

    ID

    Get-RDMSessionOTP [-ID] <guid> [-Comment <string>] [-TicketID <string>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

    PSConnection

    Get-RDMSessionOTP [-Session] <PSConnection> [-Comment <string>] [-TicketID <string>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Get the One Time Password from the specified session. If a required log field is not provided (ticket number or comment) with the corresponding parameter, a prompt will occur to obtain both fields.

    EXAMPLES

    EXAMPLE 1

    PS C:> Get-RDMSessionOTP "{00000000-0000-0000-0000-000000000000}"

    Get the OTP from the session with ID = "{00000000-0000-0000-0000-000000000000}".

    EXAMPLE 2

    PS C:> $list = Get-RDMSession; Get-RDMSessionOTP $list[1]

    Retrieves the list of available sessions and gets the OTP from the the second element in the list.

    EXAMPLE 3

    PS C:> Get-RDMSession -Name AnOTPCred | Get-RDMSessionOTP -TicketID 123 -Comment "It is a comment."

    Get the OTP from the session AnOTPCred while filling the credential viewed log, avoiding the prompt.

    PARAMETERS

    -Comment

    Comment for the credential viewed log.

    Type: System.String
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: ''

    -ID

    Specifies the ID of the session to get the OTP from.

    Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.

    Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: ID
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -Session

    Specifies the session to get the OTP from

    Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: PSConnection
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -TicketID

    Ticket number for the credential viewed log

    Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  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

    System.Guid

    RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection

    OUTPUTS

    System.Management.Automation.PSCustomObject

    NOTES

    For more information, type "Get-Help Get-RDMSessionOTP -detailed". For technical information, type "Get-Help Get-RDMSessionOTP -full".