< Back
Set-JCSystem
Post
NAME Set-JCSystem
SYNOPSIS
Updates an existing JumpCloud System
SYNTAX
Set-JCSystem [-SystemID] <System.String> [-allowMultiFactorAuthentication <System.Boolean>]
[-allowPublicKeyAuthentication <System.Boolean>] [-allowSshPasswordAuthentication <System.Boolean>]
[-allowSshRootLogin <System.Boolean>] [-displayName <System.String>] [-systemInsights <System.Boolean>]
[<CommonParameters>]
DESCRIPTION
The Set-JCSystem function updates an existing JumpCloud System. Common use cases are updated SSH parameters and
the system displayName. Actions can be completed in bulk for multiple systems by using the pipeline and Parameter
Binding to query system properties with the Get-JCSystem function and then applying updates with Set-JCSystem
function.
PARAMETERS
-SystemID <System.String>
The _id of the System which you want to remove from JumpCloud. The SystemID will be the 24 character string
populated for the _id field. SystemID has an Alias of _id. This means you can leverage the PowerShell pipeline
to populate this field automatically by calling a JumpCloud function that returns the SystemID. This is shown
in EXAMPLE 2
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-allowMultiFactorAuthentication <System.Boolean>
A boolean $true/$false value to allow for MFA during system login. Note this setting only applies systems
running Linux or Mac.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-allowPublicKeyAuthentication <System.Boolean>
A boolean $true/$false value to allow for public key authentication.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-allowSshPasswordAuthentication <System.Boolean>
A boolean $true/$false value to allow for ssh password authentication.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-allowSshRootLogin <System.Boolean>
A boolean $true/$false value to allow for ssh root login.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-displayName <System.String>
The system displayName. The displayName is set to the hostname of the system during agent installation. When
the system hostname updates the displayName does not update.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-systemInsights <System.Boolean>
Setting this value to $true will enable systemInsights and collect data for this system. Setting this value to
$false will disable systemInsights and data collection for the system.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
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
System.Boolean
OUTPUTS
System.Object
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Set-JCSystem -SystemID 5n0795a712704la4eve154r -displayName 'WorkStation001'
This example updates the displayName of the System with SystemID '5n0795a712704la4eve154r' to 'WorkStation001'.
Note the JumpCloud displayName is simply a text field and does not have any system impact.
-------------------------- Example 2 --------------------------
PS C:\\> Get-JCSystem | Where-Object os -Like *Mac* | Set-JCSystem -allowMultiFactorAuthentication $true
This example updates all Systems with an operating system like 'Mac' and allows for MFA login.
RELATED LINKS
Online Version: https://github.com/TheJumpCloud/support ... t-JCSystem
SYNOPSIS
Updates an existing JumpCloud System
SYNTAX
Set-JCSystem [-SystemID] <System.String> [-allowMultiFactorAuthentication <System.Boolean>]
[-allowPublicKeyAuthentication <System.Boolean>] [-allowSshPasswordAuthentication <System.Boolean>]
[-allowSshRootLogin <System.Boolean>] [-displayName <System.String>] [-systemInsights <System.Boolean>]
[<CommonParameters>]
DESCRIPTION
The Set-JCSystem function updates an existing JumpCloud System. Common use cases are updated SSH parameters and
the system displayName. Actions can be completed in bulk for multiple systems by using the pipeline and Parameter
Binding to query system properties with the Get-JCSystem function and then applying updates with Set-JCSystem
function.
PARAMETERS
-SystemID <System.String>
The _id of the System which you want to remove from JumpCloud. The SystemID will be the 24 character string
populated for the _id field. SystemID has an Alias of _id. This means you can leverage the PowerShell pipeline
to populate this field automatically by calling a JumpCloud function that returns the SystemID. This is shown
in EXAMPLE 2
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-allowMultiFactorAuthentication <System.Boolean>
A boolean $true/$false value to allow for MFA during system login. Note this setting only applies systems
running Linux or Mac.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-allowPublicKeyAuthentication <System.Boolean>
A boolean $true/$false value to allow for public key authentication.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-allowSshPasswordAuthentication <System.Boolean>
A boolean $true/$false value to allow for ssh password authentication.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-allowSshRootLogin <System.Boolean>
A boolean $true/$false value to allow for ssh root login.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-displayName <System.String>
The system displayName. The displayName is set to the hostname of the system during agent installation. When
the system hostname updates the displayName does not update.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-systemInsights <System.Boolean>
Setting this value to $true will enable systemInsights and collect data for this system. Setting this value to
$false will disable systemInsights and data collection for the system.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
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
System.Boolean
OUTPUTS
System.Object
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Set-JCSystem -SystemID 5n0795a712704la4eve154r -displayName 'WorkStation001'
This example updates the displayName of the System with SystemID '5n0795a712704la4eve154r' to 'WorkStation001'.
Note the JumpCloud displayName is simply a text field and does not have any system impact.
-------------------------- Example 2 --------------------------
PS C:\\> Get-JCSystem | Where-Object os -Like *Mac* | Set-JCSystem -allowMultiFactorAuthentication $true
This example updates all Systems with an operating system like 'Mac' and allows for MFA login.
RELATED LINKS
Online Version: https://github.com/TheJumpCloud/support ... t-JCSystem