< Back

Remove-RegentExportConfig

Mon Jan 13, 2020 6:54 am

NAME Remove-RegentExportConfig



SYNOPSIS

Removes a specified export job from a config file





SYNTAX

Remove-RegentExportConfig [[-PathToConfig] <String>] [-JobName] <String> [<CommonParameters>]





DESCRIPTION

Deletes the JSON entry for a specific job in the config file. The JobName is not case-sensitive.





PARAMETERS

-PathToConfig <String>

The path to the config file. Defaults to a file in the current directory called AdvancedFindExport.config.json



Required? false

Position? 1

Default value .\\AdvancedFindExport.config.json

Accept pipeline input? false

Accept wildcard characters? false



-JobName <String>

The name of the job to be removed



Required? true

Position? 2

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:\\>To remove a specific job from a config file in the current directory:



Remove-RegentExportConfig -JobName "MyUnimportantJob"









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>To remove a job from a config file in another directory. Note that the "-JobName" is implied, and therefore

optional



Remove-RegentExportConfig "MyOthernimportantJob" -PathToConfig C:\\Path\\To\\config.json











RELATED LINKS