proxmoxve.Realm.Sync

Proxmox Virtual Environment (Proxmox VE) v7.13.0, Feb 10 26

Proxmox Virtual Environment (Proxmox VE) v7.13.0 published on Tuesday, Feb 10, 2026 by Daniel Muehlbachler-Pietrzykowski

Schema (JSON)

muhlba91/pulumi-proxmoxve

Proxmox Virtual Environment (Proxmox VE) v7.13.0 published on Tuesday, Feb 10, 2026 by Daniel Muehlbachler-Pietrzykowski

Schema (JSON)

muhlba91/pulumi-proxmoxve

Import

#!/usr/bin/env sh

Realm sync resources can be imported by realm name, e.g.:

$ pulumi import proxmoxve:Realm/sync:Sync example example.com

Importing only populates the realm and id attributes; other fields must

be set in configuration.

Create Sync Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Sync(name: string, args: SyncArgs, opts?: CustomResourceOptions);

@overload
def Sync(resource_name: str,
         args: SyncArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Sync(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         realm: Optional[str] = None,
         dry_run: Optional[bool] = None,
         enable_new: Optional[bool] = None,
         full: Optional[bool] = None,
         purge: Optional[bool] = None,
         remove_vanished: Optional[str] = None,
         scope: Optional[str] = None)

func NewSync(ctx *Context, name string, args SyncArgs, opts ...ResourceOption) (*Sync, error)

public Sync(string name, SyncArgs args, CustomResourceOptions? opts = null)

public Sync(String name, SyncArgs args)
public Sync(String name, SyncArgs args, CustomResourceOptions options)

type: proxmoxve:Realm:Sync
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args SyncArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args SyncArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SyncArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SyncArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SyncArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var syncResource = new ProxmoxVE.Realm.Sync("syncResource", new()
{
    Realm = "string",
    DryRun = false,
    EnableNew = false,
    RemoveVanished = "string",
    Scope = "string",
});

example, err := realm.NewSync(ctx, "syncResource", &realm.SyncArgs{
	Realm:          pulumi.String("string"),
	DryRun:         pulumi.Bool(false),
	EnableNew:      pulumi.Bool(false),
	RemoveVanished: pulumi.String("string"),
	Scope:          pulumi.String("string"),
})

var syncResource = new Sync("syncResource", SyncArgs.builder()
    .realm("string")
    .dryRun(false)
    .enableNew(false)
    .removeVanished("string")
    .scope("string")
    .build());

sync_resource = proxmoxve.realm.Sync("syncResource",
    realm="string",
    dry_run=False,
    enable_new=False,
    remove_vanished="string",
    scope="string")

const syncResource = new proxmoxve.realm.Sync("syncResource", {
    realm: "string",
    dryRun: false,
    enableNew: false,
    removeVanished: "string",
    scope: "string",
});

type: proxmoxve:Realm:Sync
properties:
    dryRun: false
    enableNew: false
    realm: string
    removeVanished: string
    scope: string

Sync Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Sync resource accepts the following input properties:

Realm string: Name of the realm to synchronize.
DryRun bool: Only simulate the sync without applying changes.
EnableNew bool: Enable newly synced users.
Full bool: Perform a full sync.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
Purge bool: Purge removed entries.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
RemoveVanished string: How to handle vanished entries (e.g. acl;properties;entry or none).
Scope string: Sync scope: users, groups, or both.

Realm string: Name of the realm to synchronize.
DryRun bool: Only simulate the sync without applying changes.
EnableNew bool: Enable newly synced users.
Full bool: Perform a full sync.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
Purge bool: Purge removed entries.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
RemoveVanished string: How to handle vanished entries (e.g. acl;properties;entry or none).
Scope string: Sync scope: users, groups, or both.

realm String: Name of the realm to synchronize.
dryRun Boolean: Only simulate the sync without applying changes.
enableNew Boolean: Enable newly synced users.
full Boolean: Perform a full sync.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
purge Boolean: Purge removed entries.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
removeVanished String: How to handle vanished entries (e.g. acl;properties;entry or none).
scope String: Sync scope: users, groups, or both.

realm string: Name of the realm to synchronize.
dryRun boolean: Only simulate the sync without applying changes.
enableNew boolean: Enable newly synced users.
full boolean: Perform a full sync.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
purge boolean: Purge removed entries.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
removeVanished string: How to handle vanished entries (e.g. acl;properties;entry or none).
scope string: Sync scope: users, groups, or both.

realm str: Name of the realm to synchronize.
dry_run bool: Only simulate the sync without applying changes.
enable_new bool: Enable newly synced users.
full bool: Perform a full sync.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
purge bool: Purge removed entries.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
remove_vanished str: How to handle vanished entries (e.g. acl;properties;entry or none).
scope str: Sync scope: users, groups, or both.

realm String: Name of the realm to synchronize.
dryRun Boolean: Only simulate the sync without applying changes.
enableNew Boolean: Enable newly synced users.
full Boolean: Perform a full sync.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
purge Boolean: Purge removed entries.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
removeVanished String: How to handle vanished entries (e.g. acl;properties;entry or none).
scope String: Sync scope: users, groups, or both.

Outputs

All input properties are implicitly available as output properties. Additionally, the Sync resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing Sync Resource

Get an existing Sync resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SyncState, opts?: CustomResourceOptions): Sync

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dry_run: Optional[bool] = None,
        enable_new: Optional[bool] = None,
        full: Optional[bool] = None,
        purge: Optional[bool] = None,
        realm: Optional[str] = None,
        remove_vanished: Optional[str] = None,
        scope: Optional[str] = None) -> Sync

func GetSync(ctx *Context, name string, id IDInput, state *SyncState, opts ...ResourceOption) (*Sync, error)

public static Sync Get(string name, Input<string> id, SyncState? state, CustomResourceOptions? opts = null)

public static Sync get(String name, Output<String> id, SyncState state, CustomResourceOptions options)

resources:  _:    type: proxmoxve:Realm:Sync    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

DryRun bool: Only simulate the sync without applying changes.
EnableNew bool: Enable newly synced users.
Full bool: Perform a full sync.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
Purge bool: Purge removed entries.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
Realm string: Name of the realm to synchronize.
RemoveVanished string: How to handle vanished entries (e.g. acl;properties;entry or none).
Scope string: Sync scope: users, groups, or both.

DryRun bool: Only simulate the sync without applying changes.
EnableNew bool: Enable newly synced users.
Full bool: Perform a full sync.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
Purge bool: Purge removed entries.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
Realm string: Name of the realm to synchronize.
RemoveVanished string: How to handle vanished entries (e.g. acl;properties;entry or none).
Scope string: Sync scope: users, groups, or both.

dryRun Boolean: Only simulate the sync without applying changes.
enableNew Boolean: Enable newly synced users.
full Boolean: Perform a full sync.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
purge Boolean: Purge removed entries.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
realm String: Name of the realm to synchronize.
removeVanished String: How to handle vanished entries (e.g. acl;properties;entry or none).
scope String: Sync scope: users, groups, or both.

dryRun boolean: Only simulate the sync without applying changes.
enableNew boolean: Enable newly synced users.
full boolean: Perform a full sync.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
purge boolean: Purge removed entries.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
realm string: Name of the realm to synchronize.
removeVanished string: How to handle vanished entries (e.g. acl;properties;entry or none).
scope string: Sync scope: users, groups, or both.

dry_run bool: Only simulate the sync without applying changes.
enable_new bool: Enable newly synced users.
full bool: Perform a full sync.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
purge bool: Purge removed entries.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
realm str: Name of the realm to synchronize.
remove_vanished str: How to handle vanished entries (e.g. acl;properties;entry or none).
scope str: Sync scope: users, groups, or both.

dryRun Boolean: Only simulate the sync without applying changes.
enableNew Boolean: Enable newly synced users.
full Boolean: Perform a full sync.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
purge Boolean: Purge removed entries.
Deprecated: Deprecated by Proxmox: use remove_vanished instead.
realm String: Name of the realm to synchronize.
removeVanished String: How to handle vanished entries (e.g. acl;properties;entry or none).
scope String: Sync scope: users, groups, or both.

Package Details

Repository: proxmoxve muhlba91/pulumi-proxmoxve
License: Apache-2.0
Notes: This Pulumi package is based on the proxmox Terraform Provider.

Proxmox Virtual Environment (Proxmox VE) v7.13.0 published on Tuesday, Feb 10, 2026 by Daniel Muehlbachler-Pietrzykowski

Schema (JSON)

muhlba91/pulumi-proxmoxve

On this page

On this page

Import

Create Sync Resource

Constructor syntax

Parameters

Constructor example

Sync Resource Properties

Inputs

Outputs

Look up Existing Sync Resource

Package Details

On this page

On this page