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

Compare with Current View Page History

« Previous Version 15 Next »

Name

Disable-JS7Subagent

SYNOPSIS

Disables a Subagent in the JS7 Controller

SYNTAX

Disable-JS7Subagent [-SubagentId] <String[]> [[-ControllerId] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This cmdlet disables a Subagent. A disabled Subagent is not considered for job execution
by the Director Agent in a Subagent Cluster. Note that the Subagent remains dedicated
to its Controller. Disabling Subagents can be useful for example in case of maintenance windows
on the Subagent's computer.

The following REST Web Service API resources are used:

* /agents/inventory/cluster/subagents/disable

PARAMETERS

SubagentId

-SubagentId <String[]>
Specifies the unique identifier of the Subagent.

More than one Subagent can be specified by separating Subagent IDs by a comma.

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

ControllerId

-ControllerId <String>
Specifies the identification of the Controller to which the Subagent is dedicated.

Required?false
Position?2
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 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?3
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?4
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 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?5
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 > Disable-JS7Subagent -SubagentId 'subagent_001'

Disables the indicated Subagent.

  • No labels