Skip to content

Backup JCOrganization

CircleCI edited this page Feb 10, 2025 · 4 revisions

Backup-JCOrganization

SYNOPSIS

Backup your JumpCloud organization to local json files

SYNTAX

All (Default)

Backup-JCOrganization -Path <String> [-All] [-Format <String>] [-PassThru]
 [<CommonParameters>]

Type

Backup-JCOrganization -Path <String> [-Type <String[]>] [-Association] [-Format <String>] [-PassThru]
 [<CommonParameters>]

DESCRIPTION

This function exports objects and associations from your JumpCloud organization to local json files. Association takes a significant amount of time to gather. The -Format:('csv') is slower than standard json output.

EXAMPLES

EXAMPLE 1

Backup all available JumpCloud objects and their associations
PS C:\> Backup-JCOrganization -Path:('C:\Temp')

EXAMPLE 2

Backup all available JumpCloud objects and their associations to CSV (default json)
PS C:\> Backup-JCOrganization -Path:('C:\Temp') -Format:('csv')

EXAMPLE 3

Backup selected types UserGroups and Users with no associations
PS C:\> Backup-JCOrganization -Path:('C:\Temp') -Type:('UserGroup','User')

EXAMPLE 4

Backup selected types UserGroups and Users with their associations
PS C:\> Backup-JCOrganization -Path:('C:\Temp') -Type:('UserGroup','User') -Association

EXAMPLE 5

Backup UserGroups and Users without their associations
PS C:\> Backup-JCOrganization -Path:('C:\Temp') -Type:('UserGroup','User')

EXAMPLE 6

Backup all available JumpCloud objects and their associations and return metadata
PS C:\> $BackupJcOrganizationResults = Backup-JCOrganization -Path:('C:\Temp') -PassThru
PS C:\> $BackupJcOrganizationResults.Keys
PS C:\> $BackupJcOrganizationResults.User

PARAMETERS

-All

Backup all available types and associations

Type: System.Management.Automation.SwitchParameter
Parameter Sets: All
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Association

Use to backup association data

Type: System.Management.Automation.SwitchParameter
Parameter Sets: Type
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Format

The format of the output files

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Json
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

Return object metadata to pipeline

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Path

File path for backup output

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Type

JumpCloud objects that you want to backup

Type: System.String[]
Parameter Sets: Type
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS

https://github.com/TheJumpCloud/support/tree/master/PowerShell/JumpCloud%20Module/Docs/Backup-JCOrganization.md

Quick Links

Command Reference

Authentication

Import and Backup

RADIUS Reply Attributes

User Functions

Administrator Functions

System Functions

Command Functions

Group Functions

Policy Functions

Event Functions

Report Functions

Clone this wiki locally