Remove-ITGlueModuleSetting

SYNOPSIS

Removes the stored ITGlue configuration folder

SYNTAX

Remove-ITGlueModuleSetting [[-ITGlueConfigPath] <String>] [-WithVariables] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

The Remove-ITGlueModuleSetting cmdlet removes the ITGlue folder and its files This cmdlet also has the option to remove sensitive ITGlue variables as well

By default configuration files are stored in the following location and will be removed: $env:USERPROFILE\ITGlueAPI

EXAMPLES

EXAMPLE 1

Remove-ITGlueModuleSetting

Checks to see if the default configuration folder exists and removes it if it does

The default location of the ITGlue configuration folder is: $env:USERPROFILE\ITGlueAPI

EXAMPLE 2

Remove-ITGlueModuleSetting -ITGlueConfigPath C:\ITGlueAPI -WithVariables

Checks to see if the defined configuration folder exists and removes it if it does If sensitive ITGlue variables exist then they are removed as well

The location of the ITGlue configuration folder in this example is: C:\ITGlueAPI

PARAMETERS

-ITGlueConfigPath

Define the location of the ITGlue configuration folder

By default the configuration folder is located at: $env:USERPROFILE\ITGlueAPI

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

Required: False
Position: 1
Default value: $(Join-Path -Path $home -ChildPath $(if ($IsWindows -or $PSEdition -eq 'Desktop') {"ITGlueAPI"}else{".ITGlueAPI"}) )
Accept pipeline input: False
Accept wildcard characters: False

-WithVariables

Define if sensitive ITGlue variables should be removed as well

By default the variables are not removed

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

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: 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

OUTPUTS

NOTES

N/A

https://celerium.github.io/ITGlue-PowerShellWrapper/site/Internal/Remove-ITGlueModuleSetting.html

https://github.com/Celerium/ITGlue-PowerShellWrapper