PowerShell CLI 2.0 - Cmdlets - Import-JS7InventoryItem

Name

Import-JS7InventoryItem

SYNOPSIS

import inventory objects, e.g. workflows, schedules etc. from a JOC Cockpit export file

SYNTAX

Import-JS7InventoryItem [-FilePath] <String> [[-ArchiveFormat] <String>] [[-Folder] <String>] [-Overwrite] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

DESCRIPTION

JOC Cockpit inventory items can be exported with the Export-JS7InventoryItem cmdlet. The export file
created by the cmdlet can be imported by use of this cmdlet. This offers a mechanism to backup and to
restore inventory date, e.g. in case of switching the DBMS for JOC Cockpit or when upgrading to newer
JS7 releases.

PARAMETERS

FilePath

-FilePath <String>
Specifies the path to the archive file that includes objects for import to the JOC Cockpit inventory.

ArchiveFormat

-ArchiveFormat <String>
Specifies the type of the archive file that will be imported: ZIP, TAR.GZ.

If the -FilePath parameter is specified then the extension of the file name will be used for the file type.

Folder

-Folder <String>
Optionally specifies the folder in the JOC Cockpit inventory to which imported objects paths should be added.

Without this parameter any folders as specified with the import file will be used.
New folders are automatically created and optionally existing folders will be overwritten.

Overwrite

-Overwrite <SwitchParameter>
Specifies that existing objects in the JOC Cockpit invetory will be overwritten
from objects with the same path in the export file.

Without this parameter objects from the import file are ignored if objects with the same path
exist in the JOC Cockpit inventory.

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.

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.

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.

RELATED LINKS

about_JS7

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

PS > Import-JS7InventoryItem -FilePath /tmp/export.zip

Imports any objects included with the import file ("export.zip"). Objects existing with the same path in the JOC Cockpit inventory will not be overwritten.

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

PS > Import-JS7InventoryItem -Folder /some_folder -FilePath /tmp/export.tar.gz -ArchiveFormat TAR.GZ -Overwrite

Imports any objects from the given import file. As a compressed tar file is used the respective archive format is specified. Objects are added to the path /some_folder such as e.g. an object /myPath/myWorkflow that will be added to the path /some_folder/myPath/myWorkflow. Any objects existing with the same path in the JOC Cockpit inventory will be overwritten.