Support Center

The JumpCloud Sysprep Application

Using the JumpCloud MTP portal? You must use an API key for a single org admin to generate a JCSysprep.exe utility for a specific org. Using a MTP admin API key will fail. Create a single org admin, and use this admins API key to generate the JCSysprep.exe utility. 

The JumpCloud Sysprep (System Preparation) application (JCSysprep.exe) is a migration utility designed to help admins onboard to JumpCloud and prepare Windows machines for installation of the JumpCloud agent

With the JCSysprep application, administrators can update the usernames of existing local user accounts to match the usernames of the corresponding JumpCloud user accounts.

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 will occur on JumpCloud managed systems when the user to system associations are made within the JumpCloud admin console.

Local username updates with the application can be made before or after the 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.

Administrators can also use the JCSysprep application to rename the hostnames of target machines and install or uninstall the JumpCloud agent.

The JCSysprep application can be downloaded using the Get-JCSysprep command found in the JumpCloud.Sysprep PowerShell module which is hosted and available for download in the PowerShell Gallery.

Find a video tutorial for how to download and use this utility in the below video

NOTE: This module is a Windows only module that can be installed from a terminal running PowerShell version 4.0 or later.

Feature Description

The JCSysprep.exe application provides the following features:

  • Ability to update the usernames of existing local Windows user accounts.
  • Ability to update the hostnames of Windows systems.
  • Silent installation of the JumpCloud agent.
  • Ability to uninstall the JumpCloud agent.

Practical Applications

The JCSysprep.exe applications solves the following use cases:

  • Situations where existing local Windows account usernames do not match the naming convention of JumpCloud usernames and the local accounts need to be updated for account takeover to occur.
  • Situations where existing local usernames may contain a space and need to be updated. Spaces are not allowed characters in JumpCloud usernames.
  • Implementations where admins may wish to update the system hostnames prior to installing the JumpCloud agent.
  • Implementations where admins do not have the ability to silently install the JumpCloud agent and are looking for a more efficient method to manually install the JumpCloud agent.

Dependencies

  • A Windows machine running PowerShell version 4.0 or later to install the JumpCloud.Sysprep module and create the JCSysprep.exe application.
  • PowerShell version 3.0 or later to launch the JCSysprep.exe application.
  • The JCSysprep.exe application must be 'Run as Administrator'.
    • To 'Run as Administrator' right click on the JCSysprep.exe and select 'Run as Administrator'.

Installing the JumpCloud.Sysprep Module

In order to install modules on Windows systems the systems 'Execution Policy' must be set to at least 'RemoteSigned'.

To see the current value for the 'Execution Policy' launch a PowerShell terminal as admin and run the following command.

Get-ExecutionPolicy

Restricted

To set the 'Execution Policy' to 'RemoteSigned' launch a PowerShell terminal as admin and run the following command.

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned

After verifying the execution policy set for the local machine allows for module installations install the JumpCloud.Sysprep module by launching a PowerShell terminal as admin and running the following command.

Install-Module JumpCloud.Sysprep

Using the JumpCloud.Sysprep module

Creating the JCSysprep.exe Application

Using the Get-JCSysprep command admins can create their unique JCSysprep application .exe package (JCSysprep.exe).

Admins authenticate the Get-JCSysprep command using their JumpCloud API key.

Admins JumpCloud API keys 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.

The Get-JCSysprep command uses the JumpCloud API key to query the JumpCloud API and populate the JCSysprep.exe with their organization's system 'connect key'.

This system 'connect key' is used by the JCSysprep.exe application and allows for the silent installation of the JumpCloud agent.

Example:

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

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.

Find more information on the Get-JCSysprep command in its online documentation.

Using the JCSysprep.exe Application

After creating the JCSyspre application launch the JCSysprep application by right-clicking the JCSysprep.exe file and selecting 'Run as Administrator'.

NOTE that the JCSysprep application must be 'Run as Administrator' to function.

         __                          ______ __                   __
        / /__  __ ____ ___   ____   / ____// /____   __  __ ____/ /
   __  / // / / // __  __ \ / __ \ / /    / // __ \ / / / // __  /
  / /_/ // /_/ // / / / / // /_/ // /___ / // /_/ // /_/ // /_/ /
  \____/ \____//_/ /_/ /_// ____/ \____//_/ \____/ \____/ \____/
                         /_/
                                                Sysprep Utility

========================== SYSTEM INFO ============================

System Name: dmifflin01

Logged In User: dvickers

JumpCloud Agent Status: Running

============================= MENU ================================

  1. Rename a local user account

  2. Rename computer (Restart Required)

  3. Install JumpCloud Agent

  4. Uninstall JumpCloud Agent

  5. Quit

Select a menu choice:

Renaming local user accounts

To rename a local user account enter '1' at the 'Select a menu choice:' prompt.

Next enter the 'number' next to the user you would like to rename.

Note you cannot rename the current logged in account and it will not show up in the 'RENAME USER' list.

         __                          ______ __                   __
        / /__  __ ____ ___   ____   / ____// /____   __  __ ____/ /
   __  / // / / // __  __ \ / __ \ / /    / // __ \ / / / // __  /
  / /_/ // /_/ // / / / / // /_/ // /___ / // /_/ // /_/ // /_/ /
  \____/ \____//_/ /_/ /_// ____/ \____//_/ \____/ \____/ \____/
                         /_/
                                                Sysprep Utility

========================== RENAME USER ============================

Enter the number of the user you wish to rename

1. hflax
2. mscott
3. abernard

Enter a number between 1 and 3: 1

Enter a new username for user: hflax. Enter Q to return to the MENU.

It is best practice to create usernames in all lowercase

New UserName:: hscott

After selecting the user you will be presented with a prompt to enter the new username.

         __                          ______ __                   __
        / /__  __ ____ ___   ____   / ____// /____   __  __ ____/ /
   __  / // / / // __  __ \ / __ \ / /    / // __ \ / / / // __  /
  / /_/ // /_/ // / / / / // /_/ // /___ / // /_/ // /_/ // /_/ /
  \____/ \____//_/ /_/ /_// ____/ \____//_/ \____/ \____/ \____/
                         /_/
                                                Sysprep Utility

========================== RENAME USER ============================

Current Username: hflax

New Username: hscott


WARNING: Any applications that may have depended on the old username will not be updated by the Sysprep Rename Utility.

The Sysprep Rename Utility will update the DisplayName, Username, HomeFolder, and ProfileImagePath for user: hflax

It is possible that certain applications that depend on the old uername may need to be reconfigurd or reinstalled after updating the username

THE SOFTWARE IS PROVIDED  AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


Enter: 'Y' if you wish to continue or 'Q' to cancel and return to the MENU: y

Username Update Home Folder Update Registry Profile Update Display Name
--------------- ------------------ ----------------------- ------------
Success         Success            Success                 Success

Enter 'Y' at the prompt to confirm the name update or 'Q' to cancel and return to the Sysprep Utility menu.

Note: Though not explicitly stated in the SysPrep dialogue, a restart of the system should be performed after a username change. If you are going to change system hostnames or install the JumpCloud agent as well (outlined below), the restart can occur after all steps are completed. 

Updating system hostnames

To rename a systems hostname enter '2' at the 'Select a menu choice:' prompt.

Enter a new computer name into the prompt.

         __                          ______ __                   __
        / /__  __ ____ ___   ____   / ____// /____   __  __ ____/ /
   __  / // / / // __  __ \ / __ \ / /    / // __ \ / / / // __  /
  / /_/ // /_/ // / / / / // /_/ // /___ / // /_/ // /_/ // /_/ /
  \____/ \____//_/ /_/ /_// ____/ \____//_/ \____/ \____/ \____/
                         /_/
                                                Sysprep Utility

======================= RENAME COMPUTER ===========================

Enter a new computer name: sabre01

Are you sure you wish to rename computer dmifflin01 to sabre01 ?

Enter: 'Y' if you wish to complete the rename or 'Q' to cancel and return to the MENU: y
Success! The computer name has been updated PENDING RESTART

Would you like to restart now?

Enter 'Y' to restart. Enter 'N' to return to the menu:

Enter 'Y' at the prompt to confirm the system name update or 'Q' to cancel and return to the MENU.

If 'Y' is entered at the prompt the utility will ask to restart the machine to complete the system name update.

If 'N' is entered at this prompt the name update will not apply until the next system restart.

Installing the JumpCloud Agent

To install the JumpCloud agent enter '3' at the 'Select a menu choice:' prompt.

         __                          ______ __                   __
        / /__  __ ____ ___   ____   / ____// /____   __  __ ____/ /
   __  / // / / // __  __ \ / __ \ / /    / // __ \ / / / // __  /
  / /_/ // /_/ // / / / / // /_/ // /___ / // /_/ // /_/ // /_/ /
  \____/ \____//_/ /_/ /_// ____/ \____//_/ \____/ \____/ \____/
                         /_/
                                                Sysprep Utility

===================== INSTALL JUMPCLOUD AGENT =====================

Downloading agent installer... complete.
Installing agent... complete. (exit code=True)

* * * SUCCESS! Agent installation complete. * * *
Press Enter to continue:

Press 'Enter' to continue and return the Sysprep Utility main menu after installing the JumpCloud agent.

After installation, the system will register and appear within the JumpCloud admin console under the 'Systems' tab.

Uninstalling the JumpCloud Agent

To uninstall the JumpCloud agent enter '4' at the 'Select a menu choice:' prompt.

         __                          ______ __                   __
        / /__  __ ____ ___   ____   / ____// /____   __  __ ____/ /
   __  / // / / // __  __ \ / __ \ / /    / // __ \ / / / // __  /
  / /_/ // /_/ // / / / / // /_/ // /___ / // /_/ // /_/ // /_/ /
  \____/ \____//_/ /_/ /_// ____/ \____//_/ \____/ \____/ \____/
                         /_/
                                                Sysprep Utility

=================== UNINSTALL JUMPCLOUD AGENT =====================

Are you sure you wish to uninstall the JumpCloud Agent


Enter: 'Y' to continue or 'Q' to cancel and return to the MENU: y
Press Enter to continue:

Enter 'Y' at the prompt to complete the agent uninstall or 'Q' to cancel and return to the menu.

 

Last Updated: May 01, 2019 01:13PM MDT

Related Articles
desk-forwarding@jumpcloud.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete