Export-RDMDataSource

    2024-10-28

    Export-RDMDataSource

    SYNOPSIS

    Export the data source configuration

    SYNTAX

    __AllParameterSets

    Export-RDMDataSource [-InputObject] <PSDataSourceWrapper> [[-Filename] <string>] [-NoClobber]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Export the data source configuration to an RDD file. The RDD file contains only the configuration information and does not include the data source content. To prevent overwriting an existing file, use the -NoClobber parameter

    EXAMPLES

    EXAMPLE 1

    PS C:> Export-RDMDataSource -InputObject 'MyDataSource' -Filename 'C:\my\path\MyDataSource.rdd' -NoClobber

    Export the configuration of the data source 'MyDataSource' in the file 'C:\my\path\MyDataSource.rdd' if this one does not exists.

    EXAMPLE 2

    PS C:> Get-RDMDataSource | Export-RDMDataSource -Filename 'C:\my\path'

    Export the configurations of all data sources to the directory 'C:\my\path'. Each file will be named after its corresponding data source.

    PARAMETERS

    -Confirm

    Prompts you for confirmation before running the cmdlet.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
ParameterValue: []
Aliases:
- cf
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -Filename

    RDD file to create. By default, it will use the data source name.

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

    -InputObject

    Data source whose configuration will be exported

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

    -NoClobber

    NoClobber prevents an existing file from being overwritten and displays a message that the file already exists. By default, if a file exists in the specified path, it is overwritten.

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

    -WhatIf

    Shows what would happen if the cmdlet runs. The cmdlet is not run.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
ParameterValue: []
Aliases:
- wi
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

    RemoteDesktopManager.PowerShellModule.PSOutputObject.PSWrapper.PSDataSourceWrapper

    The data source configuration to export can be specified by its name, its ID, or by the PSDataSource object obtained from Get-RDMDataSource

    OUTPUTS

    NOTES

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