Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This cmdlet hides a Standalone Agent. A hidden Standalone Agent cannot be assigned a job in a workflow.
In addition a hidden Standalone Agent is not considerd with the Agent Component Status and
Agent Health Status widgets in the Dashboard view.

The following REST Web Service API resources are used:

* /agents
* /agents/inventory/store

...

-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, however, the JOC Cockpit can be configured to enforce require Audit Log comments for any all interventions.

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

...

-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.

This information is visible with shown in the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobSchedulerJS7.

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

This information is visible with shown in the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JobSchedulerJS7.

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

...

PS > Hide-JS7Agent -AgentId 'agent_001'

Hides the indicated Standalone Agent.