JS7 JobScheduler

Space shortcuts

Page tree

Name

Set-JS7FileTransferItem

SYNOPSIS

Stores a file transfer configuration to the JOC Cockpit inventory

SYNTAX

Set-JS7FileTransferItem [-Name] <String> [-Configuration] <XmlDocument> [[-Schema] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

File transfer configuration objects can be stored to JOC Cockpit. The configuration is passed on from an XML
object and is converted by the cmdlet to its native JSON reperesentation.

The following REST Web Service API resources are used:

* /xmleditor/schema/assign
* /xmleditor/apply
* /xmleditor/store
* /xmleditor/validate

PARAMETERS

Name

-Name <String>
Specifies the name of the file transfer configuration.
The name is used to display the subtab holding the file transfer configuration in the JOC Cockpit GUI.

Required?true
Position?1
Default value
Accept pipeline input?true (ByValue, ByPropertyName)
Accept wildcard characters?false

Configuration

-Configuration <XmlDocument>
Specifies the XML object that should be stored to the inventory. This parameter expects an XML
object [XML] as e.g. returned by the Get-JS7FileTransferItem cmdlet.

Required?true
Position?2
Default value
Accept pipeline input?true (ByValue, ByPropertyName)
Accept wildcard characters?false

Schema

-Schema <String>

Required?false
Position?3
Default valueYADE_configuration_v1.12.xsd
Accept pipeline input?true (ByValue, 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 the JOC Cockpit.
This parameter is not mandatory. However, the JOC Cockpit can be configured to require Audit Log comments for all interventions.

Required?false
Position?4
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 shown in the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JS7.

Required?false
Position?5
Default value0
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JS7.

This information is shown in the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JS7.

Required?false
Position?6
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

WhatIf

-WhatIf <SwitchParameter>

Required?false
Position?named
Default value
Accept pipeline input?false
Accept wildcard characters?false

Confirm

-Confirm <SwitchParameter>

Required?false
Position?named
Default value
Accept pipeline input?false
Accept wildcard characters?false

about_JS7

EXAMPLES

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

PS > $xml = Get-JS7FileTransferItem -Name 'primaryAgent'
Set-JS7FileTransferItem -Name 'newConfig' -Configuration $xml

Stores the file transfer configuration object to a new entry.

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

[xml] $xml = '<?xml version="1.0" encoding="UTF-8" standalone="no" ?> <Configurations/>'
Set-JS7FileTransferItem -Name 'newConfig' -Configuration $xml

Stores the given XML file transfer configuration to the JOC Cockpit inventory.

  • No labels