You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

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.

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

SubagentId

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

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

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.

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

Title

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

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

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

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

Ordering

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

Required?false
Position?6
Default value0
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

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.

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

ControllerId

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

Required?false
Position?7
Default value
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 JOC Cockpit.
This parameter is not mandatory, however, JOC Cockpit can be configured to enforce Audit Log comments for any interventions.

Required?false
Position?8
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 visible with 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?9
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 JS7.

This information is visible with 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?10
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

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.

  • No labels