PowerShell CLI 2.0 - Cmdlets - Set-JS7Agent

Name

Set-JS7Agent

SYNOPSIS

Add an Agent to the JS7 Controller or modify Agent properties

SYNTAX

Set-JS7Agent [-AgentId] <String> [-AgentName] <String> [-Url] <Uri> [-WatchCluster] [-Disable] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This cmdlet adds an Agent to a JS7 Controller. A number of Agent properties can be modified.

Consider that the Agent identification specified with the -AgentId parameter cannot be modified
for the lifetime of an Agent.

The following REST Web Service API resources are used:

* /agents/store

PARAMETERS

AgentId

-AgentId <String>
Specifies a unique identifier for an Agent. This identifier cannot be modified during the lifetime of an Agent.
In order to modify the Agent identifier the Agent has to be removed and added.

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

AgentName

-AgentName <String>
The name of an Agent is used e.g. in job assignments of a workflow. During deployment the Agent Name
is replaced by the respective Agent ID for the Controller to which the workflow is deployed.

Should deployments of the same workflows be performed to a number of Controllers then for each Controller
the same Agent Name has to be configured (pointing to a different Agent ID).

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

Url

-Url <Uri>
Specifies the URL for which the Agent is available. A URL includes the protocol (http, https), hostname and port
for which an Agent is operated.

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

WatchCluster

-WatchCluster <SwitchParameter>
A JS7 Controller cluster requires one Agent to be assigned the role of a cluster watcher.
Such an Agent will be considered if the JS7 Controller cluster decides about a fail-over situation with
no network connection being available between primary and secondary JS7 Controller instances.

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

Disable

-Disable <SwitchParameter>
An Agent can be disabled to prevent further use in workflow configurations. Deployed workflows still can
use a disabled Agent.

Required?	false
Position?	named
Default value	False
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 enforce Audit Log comments for any 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 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?	5
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?	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

EXAMPLES

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

PS > Set-JS7Agent -AgentId agent_001 -AgentName primaryAgent -Url https://agent-2-0-primary:4443 -WatchCluster

Adds an Agent with the specified attributes.

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

PS > Set-JS7Agent -AgentId agent_002 -AgentName secondaryAgent -Url https://agent-2-0-secondary:4443