Name
Set-JS7SubagentCluster
SYNOPSIS
Stores a Subagent Cluster to the JOC Cockpit inventory
SYNTAX
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>]
DESCRIPTION
This cmdlet stores a Subagent Cluster to the JOC Cockpit inventory that later on can be deployed to a Controller.
Consider that the Subagent Cluster identification specified with the -SubagentClusterId parameter cannot be modified
for the lifetime of a Subagent Cluster.
The following REST Web Service API resources are used:
* /agents/cluster/store
PARAMETERS
AgentId
-AgentId <String>
Specifies the unique identifier of the Cluster Agent.
| Required? | true |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
SubagentClusterId
-SubagentClusterId <String>
Specifies a unique identifier for the Subagent Cluster. This identifier cannot be modified during the lifetime of a Subagent Cluster.
In order to modify the Subagent Cluster identifier the Subagent Cluster has to be removed and added.
| Required? | true |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Title
-Title <String>
Optionally specifies a title for the Subagent Cluster that can be searched for.
| Required? | false |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
SubagentId
-SubagentId <String[]>
Specifies the unique identifier of one or more Subagents that make up a cluster.
A number of Subagent IDs can be specified separated by a comma.
| Required? | true |
| Position? | 4 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Priority
-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 | |
| 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 value | False |
| 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 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 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? | 7 |
| 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? | 8 |
| 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 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? | 9 |
| 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 |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Set-JS7SubagentCluster -AgentId 'agent_001' -SubagentClusterId 'subagent_cluster_001' -SubagentId 'subagent_001','subagent_002' -Priority 1,1
Stores a Subagent Cluster with two Subagents as an active-active cluster.
-------------------------- EXAMPLE 2 --------------------------
PS > Set-JS7SubagentCluster -AgentId 'agent_001' -SubagentClusterId 'subagent_cluster_001' -SubagentId 'subagent_001','subagent_002' -Priority 2,1
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.
Overview
Content Tools