PowerShell CLI 2.0 - Cmdlets - Set-JS7Agent

Name

Set-JS7Agent

SYNOPSIS

Add a folder to the JOC Cockpit inventory.

SYNTAX

Set-JS7Agent [-AgentId] <String> [-AgentName] <String> [-Url] <Uri> [-WatchCluster] [-Disable] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

DESCRIPTION

This cmdlet adds one or more folders to the JOC Cockpit inventory.

PARAMETERS

AgentId

-AgentId <String>

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

AgentName

-AgentName <String>

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

Url

-Url <Uri>

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

WatchCluster

-WatchCluster <SwitchParameter>

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

Disable

-Disable <SwitchParameter>

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 JOC Cockpit.
This parameter is not mandatory, however, JOC Cockpit can be configured to enforece Audit Log comments for any interventions.

Required?	false
Position?	4
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 JobScheduler.

Required?	false
Position?	5
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 JobScheduler.

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

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

EXAMPLES

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

PS > Set-JS7Agent -AgentId agent_001 -AgentName primaryAgent -Url https://agent-2-0-primary:4443 -WatchCluster

Adds an Agent with the specified attributes.

-------------------------- EXAMPLE 2 --------------------------

PS > Set-JS7Agent -AgentId agent_002 -AgentName secondaryAgent -Url https://agent-2-0-secondary:4443