< Back

Update-JCUsersFromCSV

Thu Jan 16, 2020 9:31 am

NAME Update-JCUsersFromCSV



SYNOPSIS

Updates a set of JumpCloud users from a CSV file created using the New-JCImportTemplate function.





SYNTAX

Update-JCUsersFromCSV [-CSVFilePath] <System.String> [-force] [<CommonParameters>]





DESCRIPTION

The Update-JCUsersFromCSV function does data validation when updating JumpCloud users in bulk from a CSV file to

warn the administrator of any potential issues during the import process. Examples of warnings include warning

messages for employeeIdentifiers that already exist, systems that do not exist, and groups that do not exist. The

Update-JCUserFromCSV command can be used to update user attributes, add users to groups, and bind users to systems

in bulk. The Update-JCUserFromCSV command also has a '-force' parameter which admins can use to skip the data

validate or to use the function in an automation script.





PARAMETERS

-CSVFilePath <System.String>

The full path to the CSV file you wish to import. You can use tab complete to search for .csv files.



Required? true

Position? 0

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-force <System.Management.Automation.SwitchParameter>

A SwitchParameter which suppresses the GUI and data validation when using the Update-JCUsersFromCSV command.



Required? false

Position? named

Default value False

Accept pipeline input? False

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

None







OUTPUTS

System.Object







NOTES









-------------------------- Example 1 --------------------------



PS C:\\> Update-JCUsersFromCSV ./JCUserUpdateImport_09-20-2018.csv



Updates users from the .csv file 'JCUserUpdateImport_09-20-2018.csv'

-------------------------- Example 2 --------------------------



PS C:\\> Update-JCUsersFromCSV ./JCUserUpdateImport_09-20-2018.csv -Force



Uses the 'Force' parameter to skip the GUI and data validation and update users from the file

'JCUserUpdateImport_09-20-2018.csv



RELATED LINKS

Online Version: https://github.com/TheJumpCloud/support ... ersFromCSV