Name
Import-JobSchedulerObject
SYNOPSIS
Import an XML configuration object such as a job, a job chain etc. to JOC Cockpit.
SYNTAX
Import-JobSchedulerObject [-Name] <String> [[-Directory] <String>] [-Type] <String> [-File] <String> [[-DocPath] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]
DESCRIPTION
This cmdlet imports an XML configuration object that is stored with JOC Cockpit.
However, the object is not immediately deployed, see Deploy-JobSchedulerObject cmdlet.
PARAMETERS
Name
-Name <String>
Specifies the name of the object, e.g. a job name.
| Required? | true |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Directory
-Directory <String>
Specifies the directory in JOC Cockpit to which the object should be stored.
| Required? | false |
| Position? | 2 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Type
-Type <String>
Specifies the object type which is one of:
* JOB
* JOBCHAIN
* ORDER
* PROCESSCLASS
* AGENTCLUSTER
* LOCK
* SCHEDULE
* MONITOR
* NODEPARAMS
* HOLIDAYS
| Required? | true |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
File
-File <String>
Specifies the XML file that holds the configuration object.
| Required? | true |
| Position? | 4 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
DocPath
-DocPath <String>
Specifies the path to the documentation that is assigned the object.
| Required? | false |
| Position? | 5 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditComment
-AuditComment <String>
Specifies a free text that indicates the reason for the current intervention, e.g. "business requirement", "maintenance window" etc.
The Audit Comment is visible from the Audit Log view of JOC Cockpit.
This parameter is not mandatory, however, JOC Cockpit can be configured to enforece Audit Log comments for any interventions.
| Required? | false |
| Position? | 6 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditTimeSpent
-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.
This information is visible with the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobScheduler.
| Required? | false |
| Position? | 7 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditTicketLink
-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JobScheduler.
This information is visible with the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JobScheduler.
| Required? | false |
| Position? | 8 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Import-JobSchedulerObject -Name job174 -Directory /some/directory -Type JOB -File /tmp/job174.job.xml
Import the job configuration from the given file and store the job with the specified directory and name.