Remove-RASBroker

NAME

Remove-RASBroker

SYNOPSIS

Removes a RAS Connection Broker server from a site.

SYNTAX

Remove-RASBroker [-Id] <uint> [-NoUninstall <SwitchParameter>] [<CommonParameters>]

Remove-RASBroker [-Id] <uint> -Password <SecureString> -Username <string> [<CommonParameters>]

Remove-RASBroker [-InputObject] <Broker> [-NoUninstall <SwitchParameter>] [<CommonParameters>]

Remove-RASBroker [-InputObject] <Broker> -Password <SecureString> -Username <string> [<CommonParameters>]

Remove-RASBroker [-Server] <string> [[-SiteId] <uint>] [-NoUninstall <SwitchParameter>] [<CommonParameters>]

Remove-RASBroker [-Server] <string> [[-SiteId] <uint>] -Password <SecureString> -Username <string> [<CommonParameters>]

DESCRIPTION

Modifies a RAS Connection Broker server 'Marked for Deletion'.

the RAS Connection Broker is removed once the Invoke-Apply command is called.

PARAMETERS

-Server <string> FQDN or IP address of the RAS Connection Broker server to remove.

This must be the actual server name used in the farm.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID from which to remove the RAS Connection Broker server.

If the parameter is omitted, the Licensing Server site ID will be used.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> The ID of a RAS Connection Broker to remove.

To obtain the ID, use the command to Get-RASBroker.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-NoUninstall <SwitchParameter> Include this parameter if you wish to keep the RAS Connection Broker software on the server.

To uninstall the agent software, omit this parameter.

When uninstalling the agent, your RAS admin credentials will be used by default.

You can specify different credentials by including the Username and Password parameters.

        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Username <string> A username that will be used to remotely uninstall the RAS Connection Broker software from the target server.

If this parameter is omitted, your RAS admin username and password will be used by default.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Password <SecureString> The password of the account specified in the Username parameter.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <Broker> An object of type Broker representing the RAS Connection Broker you wish to remove.

To obtain the object, use the Get-RASBroker cmdlet.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

<CommonParameters>

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

Broker

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ----------

Remove-RASBroker "server.company.dom"

Removes the specified RAS Connection Broker server from the Licensing Server Site.

To remove the server from a specific site, include the -SiteId parameter.

Last updated

© 2024 Parallels International GmbH. All rights reserved.