Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
root@www:~# z-push-admin
Usage:
	z-push-admin.php -a ACTION [options]

Parameters:
	-a list/lastsync/wipe/remove/resync/clearloop/fixstates/addshared/removeshared/listshares
	[-u] username
	[-d] deviceid
	[-t] type	the following types are available: 'email', 'calendar', 'contact', 'task', 'note', 'hierarchy' of 'gab' (for KOE) or a folder id.
	[--shared|-s]	show detailed information about shared folders of a user in list.
	[--days-old] n	show or remove profiles older than n days with lastsync or remove. n must be a positive integer.

Actions:
	list					 Lists all devices and synchronized users.
	list -u USER				 Lists all devices of user USER.
	list -d DEVICE				 Lists all users of device DEVICE.
	lastsync				 Lists all devices and synchronized users and the last synchronization time.
	wipe -u USER				 Remote wipes all devices of user USER.
	wipe -d DEVICE				 Remote wipes device DEVICE.
	wipe -u USER -d DEVICE			 Remote wipes device DEVICE of user USER.
	remove -u USER				 Removes all state data of all devices of user USER.
	remove -d DEVICE			 Removes all state data of all users synchronized on device DEVICE.
	remove -u USER -d DEVICE		 Removes all related state data of device DEVICE of user USER.
	resync -u USER -d DEVICE		 Resynchronizes all data of device DEVICE of user USER.
	resync -t TYPE 				 Resynchronizes all folders of type (possible values above) for all devices and users.
	resync -t TYPE -u USER 			 Resynchronizes all folders of type (possible values above) for the user USER.
	resync -t TYPE -u USER -d DEVICE	 Resynchronizes all folders of type (possible values above) for a specified device and user.
	resync -t FOLDERID -u USER		 Resynchronize the specified folder id only. The USER should be specified for better performance.
	resync -t hierarchy -u USER -d DEVICE	 Resynchronize the folder hierarchy data for an optional USER and optional DEVICE.
	clearloop				 Clears system wide loop detection data.
	clearloop -d DEVICE -u USER		 Clears all loop detection data of a device DEVICE and an optional user USER.
	fixstates				 Checks the states for integrity and fixes potential issues.

	addshared -u USER -d DEVICE -n FOLDERNAME -o STORE -t TYPE -f FOLDERID -g FLAGS
						 Adds a shared folder for a user.
						 USER is required. If no DEVICE is given, the shared folder will be added to all of the devices of the user.
						 FOLDERNAME the name of the shared folder. STORE - where this folder is located, e.g. "SYSTEM" (for public folder) or a username.
						 TYPE is the folder type of the shared folder (possible values above, except 'hierarchy' and 'gab').
						 FOLDERID is the id of shared folder.
						 FLAGS is optional (default: '0'). Make sure you separate -g and value with "=", e.g. -g=4.
						 Possible values for FLAGS: 0(none), 1 (Send-As from this folder), 4 (show calendar reminders for this folder), 5 (combination of Send-as and calendar reminders).
	removeshared -u USER -d DEVICE -f FOLDERID
						 Removes a shared folder for a user.
						 USER is required. If no DEVICE is given, the shared folder will be removed from all of the devices of the user.
						 FOLDERID is the id of shared folder.


	listshares -o STORE -f FOLDERID
 						 Lists opened shared folders and who opened them on which device.
						 STORE and FOLDERID are optional. If they're not provided then the script will display all open shares.
						 STORE - whose shared folders to list, e.g. "SYSTEM" (for public folders) or a username.
						 FOLDERID - list who opened the shared folder.
						 If both STORE and FOLDERID are provided the script will only list who opened the folder ignoring the STORE parameter.

The -a (action) must always be set. Each action can take several other parameters that are described on this page.

...

-d deviceid (optional) - the shared folder will be removed for the specific device.

Action: listshares (available since Z-Push 2.4.3)

Lists opened shared folder and who opened them on which device. The STORE and FOLDERID parameters are optional. Without parameters listshares will list the opened folders over all stores.

-o STORE whose shared folders to list, e.g. "SYSTEM" (for public folders) or a username.

-f FOLDERID list who opened the shared folder with the provided id.

If both STORE and FOLDERID are provided the script will only list who opened the folder ignoring the STORE parameter.

Scripting

It's possible to use the command to perform special (e.g. periodical tasks). 


Re-synchronize a batch of devices with long folderids

...