Remove-SIAConnector

SYNOPSIS

Delete a SIA connector

SYNTAX

Remove-SIAConnector [-connector_id] <String> [-force_delete] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

Deletes a connector from SIA. An active connector cannot be deleted unless -force_delete is specified. The connector service should also be removed from the host machine.

EXAMPLES

Example 1

Remove-SIAConnector -connector_id 1234-abcd

Deletes the specified connector.

PARAMETERS

-connector_id

The unique identifier of the SIA connector.

Type: String
Parameter Sets: (All)
Aliases: id

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-force_delete

Force deletion even when the connector or HTTPS relay is active or has active sessions.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

OUTPUTS

System.Object

NOTES

Requires the DpaAdmin role.

RELATED LINKS