Manage Variables

JumpCloud Command  Variables allows admins to define, manage, and reuse configuration variables that can be referenced in JumpCloud Commands. You can create and manage variables from Settings > Automation Variables that will be available across JumpCloud platform (currently only Commands). You can also manage variables from the Commands page. 

Creating a Variable

With JumpCloud Variables, you can create custom variables that you can reuse locally and across your organization.

1. Log in to the JumpCloud Admin Portal.

2. Go to Settings > Automation Variables.
3. Click +Variable.
   
   
4. In the Create New Variable dialog, enter the Variable Name. 
5. Select the Data Type:
   • String: Text-based data for names, URLs, or paths.
   • Number: Numerical values for IDs, ports, or versions.
   • Boolean: Logical datatype for True or False state.
6. Enter the Value. 

7. Define the Scope:
   • Organisation: Make the variable available across the organisation

8. Click Create Variable.

The variable is created. You will find it listed in the Variables section of the Command Details page under Custom Variables, as well as in Settings > Automation Variables. 

Editing a Variable

You can modify the details of a variable and replace the value directly from the Automation Variables page. 

1. Find the variable that you want to edit and click the three dots next to the variable.
2. Click Edit.
3. In the Edit Variable dialog, update the datatype and scope.
   
   

4. Enter the New Value. This will automatically replace the older value once the dialog is saved.
5. Click Update Variable.

You can also go to Device Management > Commands > Details, find the variable in the Variables section, and follow the steps above.

Your changes will be saved and the variable details will be updated. 

Deleting Variables

You can delete one or multiple variables from the Automation Variables page. 

To delete a variable:

1. Search and select the variables that you want to delete.
2. Click the Delete button in the top right corner.
3. In the Delete Variable dialog, enter the number of variables you are about delete.
4. Click Delete Variable.

The variables will be deleted. If the variables are associated with any commands, the commands will stop working. You must manually remove any references to the deleted variables in the associated commands. 

You can also delete a specific custom variable from the Command Details page. 

1. Go to Device Management > Commands.
2. You can either:
   • Click +Command and then select Command to create a new command. You will be taken to the Details tab of the New Command page.
   • Click a specific command name to edit the command and view the Details tab
3. Find the Custom Variable in the Variables section. 
4. Click the delete icon next to the variable.
5. Follow steps 3-4 above.

Using Variables in a Command Script

Once you’ve created a variable, you can use that variable in a command script without hard-coding the value in the Command Details section. 

1. Go to Device Management > Commands.
2. Click +Command to create a new command. See Get Started: Commands to learn more about creating commands.

To use a variable in a command:

3. In the Command Details page, go to the Variables section.
   
   
   
   All available variables are listed here in two sections:
   • Platform Variables - These are automatically populated placeholders that pull real-time contextual data (such as device hostnames, serial numbers, and OS versions). These can’t be modified.
   • Custom Variables - These are manually defined parameters created by admins to securely store reusable values for use locally and across organizations.
4. Find the variable you created in the Custom Variables section and click the copy icon next to it. 
5. Paste it in your command script in the Command section.

Creating a Custom Variable

You can also create a variable directly from the Command Details page.

1. In the Command Details page, click +Create Variable in the Variables section to create a new variable. Jump to Creating an Automation Variable to learn more.
   

Editing and Deleting Custom Variables

You can also edit and delete Custom Variables from the Command Details page.

• To edit a custom variable, click the Edit icon next to each custom variable. Jump to Editing a Variable for detailed steps.
• To delete a custom variable, click the Delete icon next to each custom variable. Jump to Deleting Variables for detailed steps.

Using Update Variables and Run

You can also update the variable used in a command directly from the Commands dashboard. 

1. On the Commands page, for a specific command, click the three dots under Actions.
2. Click Update Variables & Run. This is only available if the command uses variables.
3. Update the variables as required.
4. Click Update & Run.

The variable is updated and the command runs. You can check the re