Get-RegentExportConfig

NAME Get-RegentExportConfig



SYNOPSIS

Returns the specified Advanced Find Export job from a configuration file, or returns all of them.





SYNTAX

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





DESCRIPTION

This command deserializes the JSON of a configuration file into an object that can be used with other Powershell

commands. If a JobName is provided, only that job is returned (the JobName is not case-sensitive). Otherwise, all

jobs are returned as an array. The results of this command can be piped into several other of the utilities to

succinctly work with a configuration file.





PARAMETERS

-PathToConfig <String>

The path to the configuration file. If the file doesn't not exist, an error will be thrown.



Required? false

Position? 1

Default value .\\AdvancedFindExport.config.json

Accept pipeline input? false

Accept wildcard characters? false



-JobName <String>

The name of the export job. If none is provided, all jobs will be returned.



Required? false

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 inspect all jobs in a given configuration file:



Get-RegentExportConfig -PathToConfig C:\\path\\to\\AdvancedFindExport.config.json | Format-Table









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



PS C:\\>To export a specific find immediately.



Get-RegentExportConfig -JobName "MyUnimportantJob" | Export-RegentRecordsByFind











RELATED LINKS