Page History

...

Registers a Controller and Agents.

SYNTAX

Set-JS7Controller [-Controller] <PSObject[]> [[-AgentId] <String>] [[-AgentName] <String>] [[-AgentUrl] <Uri>] [[-ControllerId] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

...

The cmdlet registers a Controller either for a Standalone Controller instance or for
a primary and a secondary Controller Cluster instance.
A Controller Cluster requires an Agent to be added that acts as a cluster watcher.

The following REST Web Service API resources are used:

* /controller/register

PARAMETERS

Controller

-Controller <PSObject[]>
Specifies an array of Controller instances that will be added:

* For a Standalone Controller a single instance is specified
* For a Controller Cluster a primary instance and a secondary instance are specified

Controller instance objects can be created from the New-JS7ControllerInstance cmdlet.

...

-AgentId <String>
A JS7 Controller cluster requires a one an 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 withwhen
no a network connection being available between primary and secondary JS7 Controller instances is not available.

Therefore this setting is not considered when adding a Standalone Controller.
The
This parameter specifies a unique identifier for an Agent. This identifier cannot be modified during the lifetime of an the Agent.
In order to modify the Agent identifier the Agent has to be terminated and
journals have to be cleaned up.

...

-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 relevant Agent ID for the Controller to which the workflow is deployed.
Should
If deployments of the same workflows be are performed to a number of Controllers then for each Controller
the same Agent Name has to be configured for each Controller (pointing to a different Agent ID from Agents' alias names).

...

-ControllerId <String>
Specifies the Controller ID that should be used if an existing Controller is re-registered.
When adding Controllers, the ControllerID should be empty, : when updating Controllers, the Controller ID has to be specified.

...

-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 enforce require Audit Log comments for any all interventions.

...

-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.

This information is visible with shown in the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobSchedulerJS7.

...

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

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

...

Adds a Standalone Controller to JOC Cockpit that which is identified by its Url.

...

Updates an existing Standalone Controller that which is identified by its Url to a different URL or title.

...