Set-AIMConfiguration

NAME Set-AIMConfiguration



SYNOPSIS

Sets a variable in the script scope which holds default values for CLIPasswordSDK operations.

Must be run prior to other module functions if path to CLIPasswordSDK has not been previously set.





SYNTAX

Set-AIMConfiguration [[-ClientPath] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Sets properties on an object which is used as the value of a variable in the script scope.

The created variable can be queried and used by other module functions to provide default values.

Creates a file in the logged on users home folder named AIMConfiguration.xml. This file contains the variable

used by the module, and will be imported with the module into the module's scope.





PARAMETERS

-ClientPath <String>

The path to the CLIPasswordSDK.exe utility



Required? false

Position? 1

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

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 (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



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



PS C:\\>Set-AIMConfiguration -ClientPath D:\\Path\\To\\CLIPasswordSDK.exe



Sets default path to CLIPasswordSDK to D:\\Path\\To\\CLIPasswordSDK.exe.

This is accessed via the variable property $Script:AIM.ClientPath

Creates C:\\users\\user\\AIMConfiguration.xml file to hold values for persistence.











RELATED LINKS