Skip to content

Remove-VaasConnector

SYNOPSIS

Remove a VaaS connector

SYNTAX

Remove-VaasConnector [-ID] <Guid> [[-VenafiSession] <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Remove a VaaS connector

EXAMPLES

EXAMPLE 1

Remove-VaasConnector -ID $my_guid

Remove a connector

PARAMETERS

-ID

Guid of the connector

Type: Guid
Parameter Sets: (All)
Aliases: connectorId

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

-VenafiSession

Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A VaaS key can also provided.

Type: PSObject
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: $script:VenafiSession
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: None
Accept pipeline input: False
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: None
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

ID

OUTPUTS

None

NOTES

http://VenafiPS.readthedocs.io/en/latest/functions/Remove-VaasConnector/

https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Remove-VaasConnector.ps1

https://api.venafi.cloud/webjars/swagger-ui/index.html?urls.primaryName=connectors-service#/Connectors/connectors_delete