Remove-RDMRepository

    2024-12-11

    Remove-RDMRepository

    SYNOPSIS

    Delete an existing repository.

    SYNTAX

    __AllParameterSets

    Remove-RDMRepository [-ID] <guid> [[-RepositoryDestination] <PSRepositoryInfo>] [-Force]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    You will be prompted to confirm the delete.

    EXAMPLES

    EXAMPLE 1

    PS C:> $list = Get-RDMRepository; Remove-RDMRepository $list[1].ID

    Retrieves the list of available repositories, deletes repository at index 1.

    EXAMPLE 2

    PS C:> Remove-RDMRepository "{00000000-0000-0000-0000-000000000000}"

    Delete repository with ID = "{00000000-0000-0000-0000-000000000000}".

    EXAMPLE 3

    PS C:> Remove-RDMRepository-ID "{00000000-0000-0000-0000-000000000000}" -Force

    Force delete of the repository with ID = "{00000000-0000-0000-0000-000000000000}".

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

    -Force

    Forces removal of the repository without confirmation by the user. Optional.

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

    -ID

    Specifies the GUID of the repository to be deleted from.

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

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

    -RepositoryDestination

    Specifies the new repository to move the sessions from the deleted repository to.

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

    System.Guid

    RemoteDesktopManager.PowerShellModule.PSOutputObject.PSRepositoryInfo

    OUTPUTS

    NOTES

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