Skip to content

Set-VcConnector

SYNOPSIS

Update an existing connector

SYNTAX

Manifest (Default)

Set-VcConnector -ManifestPath <String> [-ID <String>] [-VenafiSession <PSObject>]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

Disable

Set-VcConnector -ID <String> [-Disable] [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Update a new machine, CA, TPP, or credential connector. You can either update the manifest or disable/reenable it.

EXAMPLES

EXAMPLE 1

Set-VcConnector -ManifestPath '/tmp/manifest_v2.json'

Update an existing connector with the same name as in the manifest

EXAMPLE 2

Set-VcConnector -ID 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f2' -ManifestPath '/tmp/manifest_v2.json'

Update an existing connector utilizing a specific connector ID

EXAMPLE 3

Set-VcConnector -ID 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f2' -Disable

Disable a connector

EXAMPLE 4

Get-VcConnector -ID 'My connector' | Set-VcConnector -Disable

Disable a connector by name

EXAMPLE 5

Set-VcConnector -ID 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f2' -Disable:$false

Reenable a disabled connector

PARAMETERS

-ManifestPath

Path to an updated manifest for an existing connector. Ensure the manifest has the deployment element which is not needed when testing in the simulator. See https://github.com/Venafi/vmware-avi-connector?tab=readme-ov-file#manifest for details.

Type: String
Parameter Sets: Manifest
Aliases:

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

-ID

Connector ID to update. If not provided, the ID will be looked up by the name in the manifest provided by ManifestPath. Note that if both ManifestPath and ID are provided and the name in the manifest is different than the one associated with ID, the name will be changed.

Type: String
Parameter Sets: Manifest
Aliases: connectorId, connector

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Type: String
Parameter Sets: Disable
Aliases: connectorId, connector

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

-Disable

Disable or reenable a connector

Type: SwitchParameter
Parameter Sets: Disable
Aliases:

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

-VenafiSession

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

Type: PSObject
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

Connector

OUTPUTS

NOTES