Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Name

Set-JS7Agent

SYNOPSIS

Add an Agent a folder to the JOC Cockpit inventoryJS7 Controller or modifies Agent properties.

SYNTAX

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

DESCRIPTION

This cmdlet adds one or more folders to the JOC Cockpit inventoryan 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.

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 Controller connected Agents have to be terminated and
journals have to be cleaned up.

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 availabl. A URL includes the protocol (http, https), hostname and port
for which an Agent is installed.

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

...

-WatchCluster <SwitchParameter>
A JS7 Controller cluster requires a minimum of 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 instance.

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

...

-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 valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...