Set-RDMCurrentDataSource

    2025-02-17

    Set-RDMCurrentDataSource

    SYNOPSIS

    Set current active data source.

    SYNTAX

    PSDatasource

    Set-RDMCurrentDataSource [[-DataSource] <PSDataSource>] [[-Username] <string>]
     [[-Password] <securestring>] [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]
    

    ID

    Set-RDMCurrentDataSource [-ID] <guid> [[-Username] <string>] [[-Password] <securestring>]
     [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]
    

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Set current active data source.

    EXAMPLES

    EXAMPLE 1

    PS C:> Set-RDMCurrentDataSource "{00000000-0000-0000-0000-000000000000}"

    Set active data source to the data source with ID = "{00000000-0000-0000-0000-000000000000}".

    EXAMPLE 2

    PS C:> $list = Get-RDMDataSource; Set-RDMCurrentDataSource $list[1].ID

    Retrieves the list of available data sources and sets the current data source the the second element in the list.

    PARAMETERS

    -DataSource

    Specifies the datasource to set current

    Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSDataSource
    DefaultValue: ''
    SupportsWildcards: false
    ParameterValue: []
    Aliases: []
    ParameterSets:
    - Name: PSDatasource
      Position: 1
      IsRequired: false
      ValueFromPipeline: true
      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 GUID of the data source to set as the current.

    The value 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: ''
    

    -Password

    Data source password

    Type: System.Security.SecureString
    DefaultValue: ''
    SupportsWildcards: false
    ParameterValue: []
    Aliases: []
    ParameterSets:
    - Name: (All)
      Position: 3
      IsRequired: false
      ValueFromPipeline: true
      ValueFromPipelineByPropertyName: false
      ValueFromRemainingArguments: false
    DontShow: false
    AcceptedValues: []
    HelpMessage: ''
    

    -Username

    Data source username

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

    RemoteDesktopManager.PowerShellModule.PSOutputObject.PSDataSource

    System.Guid

    System.Security.SecureString

    System.String

    OUTPUTS

    NOTES

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