en-US/JumpCloud.Sysprep-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-JCSysprep</command:name> <command:verb>Get</command:verb> <command:noun>JCSysprep</command:noun> <maml:description> <maml:para>The Get-JCSysprep command creates a unique JCSysprep.exe application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-JCSysprep command connects to the JumpCloud API using a JumpCloud administrator API key and creates a unique JCSysprep application '.exe' package locally which contains the authenticated JumpCloud administrators system 'connect key'.</maml:para> <maml:para>This 'connect key' is used by the application and allows for the silent installation of the JumpCloud agent.</maml:para> <maml:para>The output of this command, the JumpCloud Sysprep (System Preparation) application (JCSysprep.exe), prepares a Windows machine for installation of the JumpCloud agent.</maml:para> <maml:para>With the JCSysprep application administrators can update the usernames of existing local user accounts to match the usernames of the corresponding JumpCloud user accounts.</maml:para> <maml:para>Using the JCSysprep application to update and match the local account usernames to the naming convention of the JumpCloud usernames will ensure that local account takeover occurs on JumpCloud managed systems when user to system associations are made within the JumpCloud admin console.</maml:para> <maml:para>Account name updates with the application can be made before or after JumpCloud agent installation but must be made prior to any user to system associations within the JumpCloud admin console where there is a mismatch between the JumpCloud username and the local account username.</maml:para> <maml:para>Administrators can also use the JCSysprep application to rename the hostnames of target machines and install or uninstall the JumpCloud agent.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-JCSysprep</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>JumpCloudAPIKey</maml:name> <maml:Description> <maml:para>Your JumpCloud API key. This can be found in the JumpCloud admin console within 'API Settings' accessible from the drop down icon next to the admin email address in the top right corner of the JumpCloud admin console.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>JumpCloudAPIKey</maml:name> <maml:Description> <maml:para>Your JumpCloud API key. This can be found in the JumpCloud admin console within 'API Settings' accessible from the drop down icon next to the admin email address in the top right corner of the JumpCloud admin console.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-JCSysprep -JumpCloudAPIKey lu8792c9d4y2398is1tb6h0b83ebf0e92s97t382 Would you like to create the EXE file: JCSysprep.exe In the directory: C:\Users\buster Enter Y for 'Yes' or N for 'No': y Reading input file C:\Users\buster\JCSysprep_072418T124152.ps1 Compiling file... Output file C:\Users\buster\JCSysprep.exe written</dev:code> <dev:remarks> <maml:para>Authenticates the Get-JCSysprep command with the JumpCloudAPIKey 'lu8792c9d4y2398is1tb6h0b83ebf0e92s97t382'. The JCSysprep.exe application is created in the current working directory where the command is run. In this case the current working directory is 'C:\Users\buster'. By entering 'Y' at the prompt the JCSysprep.exe file is created in this directory.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online help Get-JCSysprep</maml:linkText> <maml:uri>https://github.com/TheJumpCloud/support/wiki/Get-JCSysprep</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |