PowerShell CLI 2.0 - Cmdlets - Set-JS7ClusterAgent

Name

Set-JS7ClusterAgent

SYNOPSIS

Stores a Cluster Agent to the JOC Cockpit inventory

SYNTAX

Set-JS7ClusterAgent [-AgentId] <String> [-AgentName] <String> [-Url] <Uri> [[-Title] <String>] [[-AgentAlias] <String[]>] [[-Subagents] <Object[]>] [[-ControllerId] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This cmdlet stores a Cluster Agent to the JOC Cockpit inventory.

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

The following REST Web Service API resources are used:

* /agents/inventory/cluster/store

PARAMETERS

AgentId

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

AgentName

-AgentName <String>
The name of a Cluster Agent is used for example in job assignments of a workflow.

During deployment of workflows the Agent Name is replaced by the respective Agent ID.

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

Url

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

Title

-Title <String>
Optionally specifies a title for the Cluster Agent that can be searched for.

AgentAlias

-AgentAlias <String[]>
Optionally specifies a number of alias names for a Cluster Agent that are separated by a comma.
An alias name is an alternative name for the same Cluster Agent that can be used when assigning Agents to jobs.

Subagents

-Subagents <Object[]>
Optionally specifies an array of Subagents objects that can be created like this:

$subagents = @()
$subagents += New-JS7Subagent -SubagentId 'subagent_001' -Url https://subagent-2-0-primary:4443
$subagents += New-JS7Subagent -SubagentId 'subagent_002' -Url https://subagent-2-0-secondary:4443

ControllerId

-ControllerId <String>
Specifies the identification of the Controller to which Cluster Agents are dedicated.

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.

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.

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.

WhatIf

-WhatIf <SwitchParameter>

Confirm

-Confirm <SwitchParameter>

RELATED LINKS

about_JS7

EXAMPLES

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

PS > $subagents = @();
$subagents += New-JS7Subagent -SubagentId 'subagent_001' -Url https://subagent-2-0-primary:4443;
$subagents += New-JS7Subagent -SubagentId 'subagent_002' -Url https://subagent-2-0-secondary:4443;
Set-JS7ClusterAgent -AgentId 'agent_001' -AgentName 'clusterAgent' -Url https://agent-2-0-cluster:4443 -Subagents $subagents -ControllerId 'testsuite'

Stores a Cluster Agent with the specified attributes and Subagents to the JOC Cockpit inventory.