Versions Compared

Key

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

...

Set-JS7SubagentCluster [-AgentId] <String> [-SubagentClusterId] <String> [[-Title] <String>] [-SubagentId] <String[]> [[-Priority] <Int32[]>] [[-Type] <String>] [-Add] [-Remove] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

...

-Priority <Int32[]>
Optionally specifies the scheduling mode in the Subagent Cluster:

* If all Subagents use the same priority then this results in an active-active cluster.
* If Subagents use different priorities then this results in an active-passive cluster.

If more than one Subagent is specified with the -SubagentId parameter then accordingly priorities have to be specified separated by a comma.

By default the same priority is applied to all Subagents which results in an active-active cluster.

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

Type

-Type <String>
Optionally specifies the cluster type:

* ACTIVE: Subagents in the cluster are used in round-robin scheduling mode
* PASSIVE: Subagents in the cluster use fixed-priority scheduling mode

This parameter cannot be used if the -Priority parameter is in place: specifying the cluster -Type causes the cmdlet to determine priorities of Subagents in the Cluster.
Alternatively the -Priority parameter allows to specify the priority per Subagent in the cluster.

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

Add

-Add <SwitchParameter>
Optionally specifies that the Subagents specified with the -SubagentId parameter are added to an existing Subagent Cluster.

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

Remove

-Remove <SwitchParameter>
Optionally specifies that the Subagents specified with the -SubagentId parameter are removed from an existing Subagent Cluster.

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

...

-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, however, the JOC Cockpit can be configured to enforce require Audit Log comments for any all interventions.

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

...

-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.

Required?false
Position?78
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 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.

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

...

Stores a Subagent Cluster with two Subagents as an active-passive cluster.

-------------------------- EXAMPLE 3 --------------------------

PS > Set-JS7SubagentCluster -AgentId 'agent_001' -SubagentClusterId 'subagent_cluster_001' -SubagentId 'subagent_003' -Add

Adds the indicated Subagent to the existing Subagent Cluster.

-------------------------- EXAMPLE 4 --------------------------

PS > Set-JS7SubagentCluster -AgentId 'agent_001' -SubagentClusterId 'subagent_cluster_001' -SubagentId 'subagent_003' -Remove

Removes the indicated Subagent from the existing Subagent Cluster.