Set-AppVentiXConfigShare

Sets the AppVentiX configuration share path for the current session.

Syntax 

# Parameter Set: Default
Set-AppVentiXConfigShare
    -ConfigShare <String>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

# Parameter Set: Credential
Set-AppVentiXConfigShare
    -ConfigShare <String>
    -Credential <PSCredential>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-AppVentiXConfigShare function sets the path to the AppVentiX configuration share. All subsequent AppVentiX cmdlets in the session use this configuration share path. Optionally, credentials can be provided to authenticate access to the share.

Parameters

-ConfigShare

The UNC path or local path to the AppVentiX configuration share.

   
Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Credential

A PSCredential object used to authenticate access to the configuration share. Required when accessing a share that requires different credentials from the current user.

   
Type: PSCredential
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the command runs without actually changing the configuration share.

   
Type: SwitchParameter
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts for confirmation before changing the configuration share.

   
Type: SwitchParameter
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Examples

Example 1: Set the configuration share 

Set-AppVentiXConfigShare -ConfigShare "\\fileserver.domain.local\config"

Sets the AppVentiX configuration share for the current session.

Example 2: Set the configuration share with credentials 

$cred = Get-Credential
Set-AppVentiXConfigShare -ConfigShare "\\fileserver.domain.local\config" -Credential $cred

Sets the configuration share and authenticates with the provided credentials.

Notes

  • The configuration share path is stored in the current session and must be set each session unless a default is configured
  • Use Get-AppVentiXConfigShare to view the currently configured share path