Skip to content

Set JCCommand

Joe Workman edited this page Aug 22, 2024 · 12 revisions

external help file: JumpCloud-help.xml Module Name: JumpCloud online version: https://github.com/TheJumpCloud/support/wiki/Set-JCCommand schema: 2.0.0

Set-JCCommand

SYNOPSIS

Updates an existing JumpCloud command

SYNTAX

Set-JCCommand [-CommandID] <String> [[-name] <String>] [[-command] <String>] [[-launchType] <String>]
 [[-timeout] <String>] -trigger <String> [<CommonParameters>]

DESCRIPTION

Updates an existing JumpCloud command using the CommandID

EXAMPLES

Example 1

Set-JCCommand -CommandID 5g6o3lf95r1485193o8cks6 -launchType trigger -trigger getWinLog

Updates the 'launchType' of command with CommandID '5g6o3lf95r1485193o8cks6' to trigger and sets the 'trigger' to getWinLog.

Example 2

Set-JCCommand -CommandID 5g6o3lf95r1485193o8cks6 -name "Windows - Get Windows Event Log"

Updates the 'name' of command with CommandID '5g6o3lf95r1485193o8cks6' to "Windows - Get Windows Event Log".

PARAMETERS

-command

The actual script or command.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CommandID

The _id of the JumpCloud command you wish to update.

To find a JumpCloud CommandID run the command:

PS C:\> Get-JCCommand | Select name, _id

The CommandID will be the 24 character string populated for the _id field.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-launchType

The launch type of the command options are: trigger, manual, repeated, one-time.

Type: System.String
Parameter Sets: (All)
Aliases:
Accepted values: trigger, manual

Required: False
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-name

The name of the new JumpCloud command.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-timeout

The time the command will run before it times out.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-trigger

Enter a trigger name. Triggers must be unique

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

OUTPUTS

System.Object

NOTES

RELATED LINKS

Quick Links

Command Reference

Authentication

Import and Backup

RADIUS Reply Attributes

User Functions

Administrator Functions

System Functions

Command Functions

Group Functions

Policy Functions

Event Functions

Clone this wiki locally