New-PveClusterJobsRealmSync

Create new realm-sync job.

API: POST /cluster/jobs/realm-sync/{id}, Proxmox VE API viewer

Syntax

New-PveClusterJobsRealmSync
    [-PveTicket <PveTicket>]
    [-Comment <string>]
    [-EnableNew <bool>]
    [-Enabled <bool>]
    -Id <string>
    [-Realm <string>]
    [-RemoveVanished <string>]
    -Schedule <string>
    [-Scope <string>]
    [<CommonParameters>]

Parameters

Parameter	Type	Required	Description
-PveTicket	PveTicket	No	Ticket data connection.
-Comment	string	No	Description for the Job.
-EnableNew	bool	No	Enable newly synced users immediately.
-Enabled	bool	No	Determines if the job is enabled.
-Id	string	Yes	The ID of the job.
-Realm	string	No	Authentication domain ID.
-RemoveVanished	string	No	A semicolon-separated list of things to remove when they or the user vanishes during a sync. The following values are possible: ‘entry’ removes the user/group when not returned from the sync. ‘properties’ removes the set properties on existing user/group that do not appear in the source (even custom ones). ‘acl’ removes acls when the user/group is not returned from the sync. Instead of a list it also can be ‘none’ (the default).
-Schedule	string	Yes	Backup schedule. The format is a subset of systemd calendar events.
-Scope	string	No	Select what to sync. Values: users, groups, both.

Every parameter also binds by property name from the pipeline, so an object with node and vmid properties (the output of Get-PveGuest, for one) fills -Node and -Vmid. Without -PveTicket the cmdlet uses the last connection, see Connection.

Output

A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.