< Back
Remove-JCCommand
Post
NAME Remove-JCCommand
SYNOPSIS
Removes a JumpCloud command
SYNTAX
Remove-JCCommand [-CommandID] <System.String> [-force] [<CommonParameters>]
DESCRIPTION
The Remove-JCCommand can remove a single JumpCloud command or multiple commands that are passed to the command
over the pipeline. The default behavior is to prompt with a warning message when deleting a command result but
this can be suppressed with the -force Parameter.
PARAMETERS
-CommandID <System.String>
The _id of the JumpCloud Command you wish to query. 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. CommandID has an Alias of _id. This
means you can leverage the PowerShell pipeline to populate this field automatically using a function that
returns the JumpCloud CommandID.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-force <System.Management.Automation.SwitchParameter>
A SwitchParameter which removes the warning message when removing a JumpCloud Command.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
OUTPUTS
System.Object
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Remove-JCCommand -CommandID 5j09o6f23dan6f4n035601d5
Removes the JumpCloud Command with a CommandID of '5j09o6f23dan6f4n035601d5'. A warning message will be presented
to confirm this operation.
-------------------------- Example 2 --------------------------
PS C:\\> Remove-JCCommand -CommandID 5j09o6f23dan6f4n035601d5 -Force
Removes the JumpCloud Command with a CommandID of '5j09o6f23dan6f4n035601d5'. A warning message will not be
presented to confirm this operation because the '-Force' parameter is used.
RELATED LINKS
Online Version: https://github.com/TheJumpCloud/support ... -JCCommand
SYNOPSIS
Removes a JumpCloud command
SYNTAX
Remove-JCCommand [-CommandID] <System.String> [-force] [<CommonParameters>]
DESCRIPTION
The Remove-JCCommand can remove a single JumpCloud command or multiple commands that are passed to the command
over the pipeline. The default behavior is to prompt with a warning message when deleting a command result but
this can be suppressed with the -force Parameter.
PARAMETERS
-CommandID <System.String>
The _id of the JumpCloud Command you wish to query. 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. CommandID has an Alias of _id. This
means you can leverage the PowerShell pipeline to populate this field automatically using a function that
returns the JumpCloud CommandID.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-force <System.Management.Automation.SwitchParameter>
A SwitchParameter which removes the warning message when removing a JumpCloud Command.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
OUTPUTS
System.Object
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Remove-JCCommand -CommandID 5j09o6f23dan6f4n035601d5
Removes the JumpCloud Command with a CommandID of '5j09o6f23dan6f4n035601d5'. A warning message will be presented
to confirm this operation.
-------------------------- Example 2 --------------------------
PS C:\\> Remove-JCCommand -CommandID 5j09o6f23dan6f4n035601d5 -Force
Removes the JumpCloud Command with a CommandID of '5j09o6f23dan6f4n035601d5'. A warning message will not be
presented to confirm this operation because the '-Force' parameter is used.
RELATED LINKS
Online Version: https://github.com/TheJumpCloud/support ... -JCCommand