Remove-RocketCyberModuleSettings
SYNOPSIS
Removes the stored RocketCyber configuration folder.
SYNTAX
Remove-RocketCyberModuleSettings [-RocketCyberConfPath <String>] [-AndVariables] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
The Remove-RocketCyberModuleSettings cmdlet removes the RocketCyber folder and its files. This cmdlet also has the option to remove sensitive RocketCyber variables as well.
By default configuration files are stored in the following location and will be removed: $env:USERPROFILE\RocketCyberAPI
EXAMPLES
EXAMPLE 1
Remove-RocketCyberModuleSettings
Checks to see if the default configuration folder exists and removes it if it does.
The default location of the RocketCyber configuration folder is: $env:USERPROFILE\RocketCyberAPI
EXAMPLE 2
Remove-RocketCyberModuleSettings -RocketCyberConfPath C:\RocketCyberAPI -AndVariables
Checks to see if the defined configuration folder exists and removes it if it does. If sensitive RocketCyber variables exist then they are removed as well.
The location of the RocketCyber configuration folder in this example is: C:\RocketCyberAPI
PARAMETERS
-RocketCyberConfPath
Define the location of the RocketCyber configuration folder.
By default the configuration folder is located at: $env:USERPROFILE\RocketCyberAPI
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: $(Join-Path -Path $home -ChildPath $(if ($IsWindows -or $PSEdition -eq 'Desktop'){"RocketCyberAPI"}else{".RocketCyberAPI"}) )
Accept pipeline input: False
Accept wildcard characters: False
-AndVariables
Define if sensitive RocketCyber variables should be removed as well.
By default the variables are not removed.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
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