< Back
Get-JCSystem
Post
NAME Get-JCSystem
SYNOPSIS
Returns all JumpCloud Systems within a JumpCloud tenant or a single JumpCloud System using the -ByID Parameter.
SYNTAX
Get-JCSystem [-SystemFDEKey] -SystemID <System.String> -date <System.String> -dateFilter {before | after}
[<CommonParameters>]
Get-JCSystem [[-hostname] <System.String>] [-active <System.Boolean>] [-agentVersion <System.String>]
[-allowMultiFactorAuthentication <System.Boolean>] [-allowPublicKeyAuthentication <System.Boolean>]
[-allowSshPasswordAuthentication <System.Boolean>] [-allowSshRootLogin <System.Boolean>] [-arch <System.String>]
-date <System.String> -dateFilter {before | after} [-displayName <System.String>] [-filterDateProperty {created}]
[-modifySSHDConfig <System.Boolean>] [-os <System.String>] [-remoteIP <System.String>] [-returnProperties {created
| active | agentVersion | allowMultiFactorAuthentication | allowPublicKeyAuthentication |
allowSshPasswordAuthentication | allowSshRootLogin | arch | created | displayName | hostname | lastContact |
modifySSHDConfig | organization | os | remoteIP | serialNumber | sshdParams | systemTimezone | templateName |
version | fde | systemInsights}] [-serialNumber <System.String>] [-systemTimezone <System.String>] [-templateName
<System.String>] [-version <System.String>] [<CommonParameters>]
DESCRIPTION
The Get-JCSystem function returns all information describing a JumpCloud system. By default this will return all
Systems.
PARAMETERS
-SystemFDEKey <System.Management.Automation.SwitchParameter>
A switch parameter to reveal the SystemFDEKey
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SystemID <System.String>
The _id or id of the System which you want to query.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-active <System.Boolean>
Filter for systems that are online or offline.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-agentVersion <System.String>
A search filter to search systems by the agentVersion.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-allowMultiFactorAuthentication <System.Boolean>
A search filter to show systems that are enabled ($true) or disabled ($true) for allowMultiFactorAuthentication
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-allowPublicKeyAuthentication <System.Boolean>
A search filter to show systems that are enabled ($true) or disabled ($true) for allowMultiFactorAuthentication
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-allowSshPasswordAuthentication <System.Boolean>
A search filter to show systems that are enabled ($true) or disabled ($true) for allowMultiFactorAuthentication
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-allowSshRootLogin <System.Boolean>
A search filter to show systems that are enabled ($true) or disabled ($true) for allowMultiFactorAuthentication
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-arch <System.String>
A search filter to search systems by the processor arch.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-date <System.String>
Date to filter on.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-dateFilter <System.String>
Condition to filter date on.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-displayName <System.String>
A search filter to search systems by the displayName.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-filterDateProperty <System.String>
A parameter that can filter on the property 'created'. This parameter if used creates two more dynamic
parameters 'dateFilter' and 'date'. See EXAMPLE 5 above for full syntax.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-hostname <System.String>
A search filter to search systems by the hostname.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-modifySSHDConfig <System.Boolean>
A search filter to show systems that are enabled ($true) or disabled ($true) for modifySSHDConfig
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-os <System.String>
A search filter to search systems by the OS.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-remoteIP <System.String>
A search filter to search systems by the remoteIP.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-returnProperties <System.String[]>
Allows you to return select properties on JumpCloud system objects. Specifying what properties are returned
can drastically increase the speed of the API call with a large data set. Valid properties that can be
returned are: 'created', 'active', 'agentVersion', 'allowMultiFactorAuthentication',
'allowPublicKeyAuthentication', 'allowSshPasswordAuthentication', 'allowSshRootLogin', 'arch', 'created',
'displayName', 'hostname', 'lastContact', 'modifySSHDConfig', 'organization', 'os', 'remoteIP',
'serialNumber', 'sshdParams', 'systemTimezone', 'templateName', 'version'
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-serialNumber <System.String>
A search filter to search systems by the serialNumber.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-systemTimezone <System.String>
A search filter to search systems by the serialNumber. This field DOES NOT take wildcard input.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-templateName <System.String>
A search filter to search systems by the templateName.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-version <System.String>
A search filter to search systems by the version.
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.Management.Automation.SwitchParameter
System.Boolean
System.String[]
OUTPUTS
System.Object
NOTES
-------------------------- Example 1 --------------------------
Get-JCSystem
Returns all JumpCloud managed systems and the information describing these systems.
-------------------------- Example 2 --------------------------
Get-JCSystemUser -SystemID 5n0795a712704la4eve154r
Returns a single JumpCloud System with SystemID '5n0795a712704la4eve154r'.
-------------------------- Example 3 --------------------------
Get-JCSystem -active $true
Returns all active JumpCloud Systems and the information describing these systems.
-------------------------- Example 4 --------------------------
Get-JCSystem -agentVersion '0.9.6*' -os '*Mac*'
Returns all JumpCloud systems where the agentVersion is '0.9.6. ' and the operating system is like ' Mac*'
-------------------------- Example 5 --------------------------
Get-JCSystem -filterDateProperty created -dateFilter after -date 01/01/2018
Returns all JumpCloud systems that were created after 01/01/2018 using the parameter -filterDateProperty and the
dynamic parameters -dateFilter and -date
-------------------------- Example 6 --------------------------
Get-JCSystem -returnProperties remoteIP, active
Returns all JumpCloud systems and the properties remoteIP and active. The default properties that return are
lastContact and _id.
RELATED LINKS
Online Version: https://github.com/TheJumpCloud/support ... t-JCSystem
SYNOPSIS
Returns all JumpCloud Systems within a JumpCloud tenant or a single JumpCloud System using the -ByID Parameter.
SYNTAX
Get-JCSystem [-SystemFDEKey] -SystemID <System.String> -date <System.String> -dateFilter {before | after}
[<CommonParameters>]
Get-JCSystem [[-hostname] <System.String>] [-active <System.Boolean>] [-agentVersion <System.String>]
[-allowMultiFactorAuthentication <System.Boolean>] [-allowPublicKeyAuthentication <System.Boolean>]
[-allowSshPasswordAuthentication <System.Boolean>] [-allowSshRootLogin <System.Boolean>] [-arch <System.String>]
-date <System.String> -dateFilter {before | after} [-displayName <System.String>] [-filterDateProperty {created}]
[-modifySSHDConfig <System.Boolean>] [-os <System.String>] [-remoteIP <System.String>] [-returnProperties {created
| active | agentVersion | allowMultiFactorAuthentication | allowPublicKeyAuthentication |
allowSshPasswordAuthentication | allowSshRootLogin | arch | created | displayName | hostname | lastContact |
modifySSHDConfig | organization | os | remoteIP | serialNumber | sshdParams | systemTimezone | templateName |
version | fde | systemInsights}] [-serialNumber <System.String>] [-systemTimezone <System.String>] [-templateName
<System.String>] [-version <System.String>] [<CommonParameters>]
DESCRIPTION
The Get-JCSystem function returns all information describing a JumpCloud system. By default this will return all
Systems.
PARAMETERS
-SystemFDEKey <System.Management.Automation.SwitchParameter>
A switch parameter to reveal the SystemFDEKey
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SystemID <System.String>
The _id or id of the System which you want to query.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-active <System.Boolean>
Filter for systems that are online or offline.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-agentVersion <System.String>
A search filter to search systems by the agentVersion.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-allowMultiFactorAuthentication <System.Boolean>
A search filter to show systems that are enabled ($true) or disabled ($true) for allowMultiFactorAuthentication
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-allowPublicKeyAuthentication <System.Boolean>
A search filter to show systems that are enabled ($true) or disabled ($true) for allowMultiFactorAuthentication
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-allowSshPasswordAuthentication <System.Boolean>
A search filter to show systems that are enabled ($true) or disabled ($true) for allowMultiFactorAuthentication
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-allowSshRootLogin <System.Boolean>
A search filter to show systems that are enabled ($true) or disabled ($true) for allowMultiFactorAuthentication
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-arch <System.String>
A search filter to search systems by the processor arch.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-date <System.String>
Date to filter on.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-dateFilter <System.String>
Condition to filter date on.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-displayName <System.String>
A search filter to search systems by the displayName.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-filterDateProperty <System.String>
A parameter that can filter on the property 'created'. This parameter if used creates two more dynamic
parameters 'dateFilter' and 'date'. See EXAMPLE 5 above for full syntax.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-hostname <System.String>
A search filter to search systems by the hostname.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-modifySSHDConfig <System.Boolean>
A search filter to show systems that are enabled ($true) or disabled ($true) for modifySSHDConfig
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-os <System.String>
A search filter to search systems by the OS.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-remoteIP <System.String>
A search filter to search systems by the remoteIP.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-returnProperties <System.String[]>
Allows you to return select properties on JumpCloud system objects. Specifying what properties are returned
can drastically increase the speed of the API call with a large data set. Valid properties that can be
returned are: 'created', 'active', 'agentVersion', 'allowMultiFactorAuthentication',
'allowPublicKeyAuthentication', 'allowSshPasswordAuthentication', 'allowSshRootLogin', 'arch', 'created',
'displayName', 'hostname', 'lastContact', 'modifySSHDConfig', 'organization', 'os', 'remoteIP',
'serialNumber', 'sshdParams', 'systemTimezone', 'templateName', 'version'
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-serialNumber <System.String>
A search filter to search systems by the serialNumber.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-systemTimezone <System.String>
A search filter to search systems by the serialNumber. This field DOES NOT take wildcard input.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-templateName <System.String>
A search filter to search systems by the templateName.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-version <System.String>
A search filter to search systems by the version.
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.Management.Automation.SwitchParameter
System.Boolean
System.String[]
OUTPUTS
System.Object
NOTES
-------------------------- Example 1 --------------------------
Get-JCSystem
Returns all JumpCloud managed systems and the information describing these systems.
-------------------------- Example 2 --------------------------
Get-JCSystemUser -SystemID 5n0795a712704la4eve154r
Returns a single JumpCloud System with SystemID '5n0795a712704la4eve154r'.
-------------------------- Example 3 --------------------------
Get-JCSystem -active $true
Returns all active JumpCloud Systems and the information describing these systems.
-------------------------- Example 4 --------------------------
Get-JCSystem -agentVersion '0.9.6*' -os '*Mac*'
Returns all JumpCloud systems where the agentVersion is '0.9.6. ' and the operating system is like ' Mac*'
-------------------------- Example 5 --------------------------
Get-JCSystem -filterDateProperty created -dateFilter after -date 01/01/2018
Returns all JumpCloud systems that were created after 01/01/2018 using the parameter -filterDateProperty and the
dynamic parameters -dateFilter and -date
-------------------------- Example 6 --------------------------
Get-JCSystem -returnProperties remoteIP, active
Returns all JumpCloud systems and the properties remoteIP and active. The default properties that return are
lastContact and _id.
RELATED LINKS
Online Version: https://github.com/TheJumpCloud/support ... t-JCSystem