PowerShell CLI 2.0 - Cmdlets - Set-JS7Subagent

Name

Set-JS7Subagent

SYNOPSIS

Stores a Subagent to a Cluster Agent

SYNTAX

Set-JS7Subagent [-AgentId] <String> [-SubagentId] <String> [-Url] <Uri> [[-Title] <String>] [[-DirectorType] <String>] [[-Ordering] <Int32>] [-GenerateSubagentCluster] [[-ControllerId] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This cmdlet stores a Subagent to a Cluster Agent.

Consider that the Subagent identification specified with the -SubagentId parameter cannot be modified
for the lifetime of a Subagent.

The following REST Web Service API resources are used:

* /agents/inventory/cluster/subagents/store

PARAMETERS

AgentId

-AgentId <String>
Specifies a unique identifier of the Cluster Agent. The Subagent will be assigned the given Cluster Agent.

SubagentId

-SubagentId <String>
Specifies a unique identifier for the Subagent. The Subagent ID cannot be changed during the lifetime of a Subagent.

Url

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

Title

-Title <String>
Optionally specifies a title for the Subagent that can later on be used for searching.

DirectorType

-DirectorType <String>
Specifies if the Subagent acts as a Director Agent or Subagent only. The following values can be used:

* NO_DIRECTOR: the Agent acts as a Subagent only
* PRIMARY_DIRECTOR: the Agent acts as a Primary Director Agent and includes a Subagent
* SECONDARY_DIRECTOR: the Agent acts as a Secondary Director Agent and includes a Subagent

Ordering

-Ordering <Int32>
Optionally specifies the sequence in which Subagents are returned and displayed by JOC Cockpit.
The ordering is specified in ascending numbers.

GenerateSubagentCluster

-GenerateSubagentCluster <SwitchParameter>
Optionally specifies if a Subagent Cluster should be created that holds the Subagent as its unique member.
This option is useful if the Subagent Cluster should be assigned directly to jobs that rely on being
executed with the Subagent only.

ControllerId

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

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 > Set-JS7Subagent -AgentId 'agent_001' -SubagentId 'subagent_001' -Url https://subagent-2-0-primary:4443 -ControllerId 'testsuite'

Stores a Subagent with the specified attributes to the given Cluster Agent and Controller.