From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id DA8B76DFCE for ; Mon, 28 Mar 2022 14:38:43 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id CC248259DE for ; Mon, 28 Mar 2022 14:38:13 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 0A9A62599F for ; Mon, 28 Mar 2022 14:38:12 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id D2CE042866 for ; Mon, 28 Mar 2022 14:38:11 +0200 (CEST) From: Dominik Csapak To: pve-devel@lists.proxmox.com Date: Mon, 28 Mar 2022 14:38:07 +0200 Message-Id: <20220328123807.233098-7-d.csapak@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220328123807.233098-1-d.csapak@proxmox.com> References: <20220328123807.233098-1-d.csapak@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.148 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record T_SCC_BODY_TEXT_LINE -0.01 - Subject: [pve-devel] [PATCH docs v4 1/1] update documentation about sync-options X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 28 Mar 2022 12:38:43 -0000 describe the new 'remove-vanished' option and what the options are doing Signed-off-by: Dominik Csapak --- pveum.adoc | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/pveum.adoc b/pveum.adoc index a5c8906..99e1a45 100644 --- a/pveum.adoc +++ b/pveum.adoc @@ -355,13 +355,21 @@ The main options for syncing are: * `Enable new` (`enable-new`): If set, the newly synced users are enabled and can log in. The default is `true`. -* `Full` (`full`): If set, the sync uses the LDAP directory as a source of - truth, overwriting information set manually in the `user.cfg` and deleting - users and groups which are not present in the LDAP directory. If not set, only - new data is written to the configuration, and no stale users are deleted. +* `Remove Vanished` (`remove-vanished`): This is a list of options which, when + activated, determine if they are removed when they are not returned from + the sync response. The options are: -* `Purge ACLs` (`purge`): If set, sync removes all corresponding ACLs when - removing users and groups. This is only useful with the option `full`. + - `ACL` (`acl)`: Remove ACLs of users and groups which were not returned + returned in the sync response. This most often makes sense together with + `Entry`. + + - `Entry` (`entry`): Removes entries (i.e. users and groups) when they are + not returned in the sync response. + + - `Properties` (`properties`): Removes properties of entries which were + not returned in the sync response. This includes custom properties + which were never set by the sync. Exceptions are tokens and the enable + flag. Those will be retained even with this option. * `Preview` (`dry-run`): No data is written to the config. This is useful if you want to see which users and groups would get synced to the `user.cfg`. -- 2.30.2