ZeXtras CLI/es

From ZeXtras Suite Wiki

Jump to: navigation, search
Idioma: English  • español • português
Zextras logo box.png
Latest Version: 2.12.2
Released on: January 2nd, 2019
Compatibility List
Changelog
License Management

Interfaz de la línea de comandos de ZeXtras Suite - zxsuite

La versión 1.0 de ZeXtras Suite introdujo la opción CLI que permite a los administradores realizar operaciones directamente desde la línea de comandos del servidor. Esta característica es bastante útil para aquellos que necesitan insertar operaciones de ZeXtras Suite en un Script.

Warning.png ¡Atención!

Esta es sólo una línea de comandos de referencia. Para una descripción completa y ejemplo de uso por favor ejecute `zxsuite help {module} [command]`

Uso básico

Ayuda Online: Se encuentra disponible una ayuda para cada comando con zxsuite help {module} [command]. Si se omite el comando se mostrará la lista completa con todos los que estén disponibles.

Línea de comandos del Core

Uso Básico:

zxsuite core {action} [options]

Comandos del Core

getVersion - Muestra la versión ZeXtras Suite
                            zxsuite core getVersion 
getProperty - Obtiene las propiedades de configuracipon
                            zxsuite core getProperty [attr1 value1 [attr2 value2...]]
setProperty - Establece las propiedades de configuracipon
                            zxsuite core setProperty {property_name} {property_value} 
getLicenseInfo - Muestra información sobre las licencias ZeXtras Suite
                            zxsuite core getLicenseInfo
doUploadLicense - Carga una licencia ZeXtras
                            zxsuite core doUploadLicense {license_path} 
doLicenseChecks - Fuerza un chequeo de las licencias ZeXtras
                            zxsuite core doLicenseChecks 
getUpdateInfo - Muestra información sobre actualizaciones de ZeXtras Suite
                            zxsuite core getUpdateInfo core getUpdateInfo
doCheckUpdate - Pide informacion sobre actualizaciones al servidor ZeXtras Suite
                            zxsuite core doCheckUpdate 
getAccountStats - Muestra información estadística sobre una cuenta dada o ID
                            zxsuite core getAccountStats {account} 
getNotification - Muestra notificaciones de ZeXtras
                            zxsuite core getNotification [attr1 value1 [attr2 value2...]]
doDeleteAllDelegatedRights - Este comando borra las configuraciónes de ZeXtras Admin y de administración delegada de Zimbra
                            zxsuite core doDeleteAllDelegatedRights {confirmation string}

Línea de comandos del Backup

Uso básico:

zxsuite backup {action} [options]

Comandos de ZxBackup

getProperty - Muestra las propiedades de configuración
                            zxsuite backup getProperty [attr1 value1 [attr2 value2...]]
setProperty - Establece propiedades de configuración
                            zxsuite backup setProperty {property_name} {property_value} 
doFullScan - Ejecuta un Full Scan
                            zxsuite backup doFullScan [attr1 value1 [attr2 value2...]]
doSmartScan - Ejecuta un Smart Scan
                            zxsuite backup doSmartScan [attr1 value1 [attr2 value2...]]
doAccountScan - Ejecuta un Full Scan en un único buzón
                            zxsuite backup doAccountScan {account} [attr1 value1 [attr2 value2...]]
doExport - Ejecuta una exportación limitada por dominios
                            zxsuite backup doExport {destination_path} [attr1 value1 [attr2 value2...]]
doRestoreOnNewAccount - Ejecuta un Restore on New Account
                            zxsuite backup doRestoreOnNewAccount {source_account} {destination_account} {"dd/MM/yyyy HH:mm:ss"|last} [attr1 value1 [attr2 value2...]]
doEnableDisableCOS - Habilita o deshabilita el backup para una COS específica
                            zxsuite backup doEnableDisableCOS {cos_name} {enable|disable} 
doUndelete - Ejecuta un Undelete Restore
                            zxsuite backup doUndelete {account} {"dd/MM/yyyy HH:mm:ss"|first} {"dd/MM/yyyy HH:mm:ss"|last} [attr1 value1 [attr2 value2...]]
doItemSearch - Busca un elemento
                            zxsuite backup doItemSearch {account} [attr1 value1 [attr2 value2...]]
doItemRestore - Recupera un elemento individualmente
                            zxsuite backup doItemRestore {account_name} {item_id} 
doExternalRestore - Realiza un External Restore
                            zxsuite backup doExternalRestore {source_path} [attr1 value1 [attr2 value2...]]
doStopOperation - Detiene una operación en ejecución
                            zxsuite backup doStopOperation {operation_uuid} 
doStopAllOperations - Detiene todas las operaciones en ejecución y vacía la cola de operaciones
                            zxsuite backup doStopAllOperations 
doCheckShares - Verifica todas las comparticiones en cuentas locales
                            zxsuite backup doCheckShares 
doFixShares - Intenta reparar todas las comparticiones en las cuentas locales
                            zxsuite backup doFixShares {import_idmap_file} 
doFixOrphans - Elimina archivos huérfanos
                            zxsuite backup doFixOrphans [attr1 value1 [attr2 value2...]]
doCoherencyCheck - Verifica coherencia del backup
                            zxsuite backup doCoherencyCheck {backup_path} [attr1 value1 [attr2 value2...]]
getAccountInfo - Muestra la información de una cuenta
                            zxsuite backup getAccountInfo {account} [attr1 value1 [attr2 value2...]]
getBackupInfo - Muestra información acerca del sistema de backup
                            zxsuite backup getBackupInfo [attr1 value1 [attr2 value2...]]
getMap - Muestra objeto de mapa binario <String, String> como una tabla legible
                            zxsuite backup getMap {file_path} 
getItem - Muestra elemento en formato legible.
                            zxsuite backup getItem {account} {item} [attr1 value1 [attr2 value2...]]
getAvailableAccounts - Muestra todas las cuentas disponibles para restaurar
                            zxsuite backup getAvailableAccounts [attr1 value1 [attr2 value2...]]
getAvailableDomains - Muestra todos los dominios disponibles para restaurar
                            zxsuite backup getAvailableDomains {dd/MM/yyyy HH:mm:ss|"last"} {backup_path} 
getServerConfig - Provee una lista de configuraciones de servidores almacenados
                            zxsuite backup getServerConfig {"dd/MM/yyyy HH:mm:ss"|"last"|"all"} {standard|customizations} [attr1 value1 [attr2 value2...]]
getCOSBackupStatus - Muestra el estado del backup de todas las COS
                            zxsuite backup getCOSBackupStatus [attr1 value1 [attr2 value2...]]
getAllOperations - Muestra todas las operaciones en ejecución y en cola
                            zxsuite backup getAllOperations 
monitor - Monitorea una operación en curso
                            zxsuite backup monitor {operation_uuid} [attr1 value1 [attr2 value2...]]

Línea de comandos del Mobile

Uso básico:

zxsuite mobile {action} [options]

Comandos de ZxMobile

getProperty - Obtiene propiedades de configuración.
                            zxsuite mobile getProperty [attr1 value1 [attr2 value2...]]
setProperty - Establece propiedades de configuración
                            zxsuite mobile setProperty {property_name} {property_value} 
getDeviceList - Muestra todos los dispositivos para la cuenta provista.
                            zxsuite mobile getDeviceList {account} 
getDeviceInfo - Muestra información sobre el dispositivo provisto.
                            zxsuite mobile getDeviceInfo {account} {device_id} 
doResetAccount - Resetea los estados de TODOS los dispositivos para la cuenta provista.
                            zxsuite mobile doResetAccount {account} 
doResetDevice - Resetea el SynState del dispositivo para una cuenta
                            zxsuite mobile doResetDevice {account} [attr1 value1 [attr2 value2...]]
getAllSessions - Muestra información sobre todas las sesiones mobiles almacenadas
                            zxsuite mobile getAllSessions 
getActiveSessions - Muestra todas las sesiones móbiles activas
                            zxsuite mobile getActiveSessions 
doRemoveDevice - Remueve el SyncState e historial de todos los dispositivos del servidor
                            zxsuite mobile doRemoveDevice {account} {device_id} 
getAccountLoggers - Devuelve informaciones sobre los loggers de todas las cuentas
                            zxsuite mobile getAccountLoggers 
doRemoveLogger - Remueve un logger de la cuenta
                            zxsuite mobile doRemoveLogger {logger_id|"all_loggers"} 
doAddAccountLogger - Agrega un logger a la cuenta
                            zxsuite mobile doAddAccountLogger {account} {debug|info|warn|err|crit} {log_file}

Línea de comandos de ZxPowerstore

Uso básico:

zxsuite powerstore {action} [options]

Comandos de ZxPowerstore

getProperty - Muestra propiedades de configuración
                            zxsuite powerstore getProperty [attr1 value1 [attr2 value2...]]
setProperty - Establece propiedades de configuración
                            zxsuite powerstore setProperty {property_name} {property_value} 
getAllVolumes - Muestra todos los volúmenes presentes en el servidor
                            zxsuite powerstore getAllVolumes 
getHsmPolicy - Muestra las políticas
                            zxsuite powerstore getHsmPolicy 
setHsmPolicy - Establece la política HSM por defecto
                            zxsuite powerstore setHsmPolicy {hsm_policy} 
+setHsmPolicy - Añade una política HSM adicional
                            zxsuite powerstore +setHsmPolicy {hsm_policy} 
doCreateVolume - Crea un volúmen en el servidor
                            zxsuite powerstore doCreateVolume {primary|secondary|index} {volume_name} {volume_path} [attr1 value1 [attr2 value2...]]
doUpdateVolume - Actualiza un volúmen específico en el servidor
                            zxsuite powerstore doUpdateVolume {volume_id} [attr1 value1 [attr2 value2...]]
doDeleteVolume - Elimina un volúmen específico en el servidor
                            zxsuite powerstore doDeleteVolume {volume_id} 
doMoveBlobs - Inicia la operación doMoveBlob
                            zxsuite powerstore doMoveBlobs [attr1 value1 [attr2 value2...]]
doDeduplicate - Inicia la operación de des-duplicación
                            zxsuite powerstore doDeduplicate {volume_name} [attr1 value1 [attr2 value2...]]
doVolumeToVolumeMove - Inicia la operación doMoveVolumeBlobs
                            zxsuite powerstore doVolumeToVolumeMove {source_volume_name} {destination_volume_name} 
getAllOperations - Muestra las operaciones en curso y en cola
                            zxsuite powerstore getAllOperations 
monitor - Monitorea una operación en curso
                            zxsuite powerstore monitor {operation_uuid} [attr1 value1 [attr2 value2...]]
doStopAllOperations - Detiene las operaciones en curso y vacía la cola de operaciones
                            zxsuite powerstore doStopAllOperations
getVolumeStats - Muestra el espacio ocupado, número de elementos y blobs (Binary Large Objects) contenidos en un volúmen
                            zxsuite powerstore getVolumeStats {volume_id} [attr1 value1 [attr2 value2...]]

Línea de comandos de ZxAdmin

Uso básico:

zxsuite admin {action} [options]

Comandos de ZxAdmin

getDelegationSettings - Muestra los Administradores Delegados con sus dominios de competencia, el atributo viewMail y la cuota asignable
                            zxsuite admin getDelegationSettings [attr1 value1 [attr2 value2...]]
doEditDelegationSettings -
                            zxsuite admin doEditDelegationSettings {account} {domain} [attr1 value1 [attr2 value2...]]
doAddDelegationSettings -
                            zxsuite admin doAddDelegationSettings {account} {domain} [attr1 value1 [attr2 value2...]]
doRemoveDelegationSettings -
                            zxsuite admin doRemoveDelegationSettings {account} {domain} 
getDomainSettings - Muestra el nombre, límite de número de cuentas y cuota máxima de cuenta de todos los dominios
                            zxsuite admin getDomainSettings 
setDomainSettings - Establece cuota máxima de la cuenta del dominio y límite de cuenta
                            zxsuite admin setDomainSettings {domain} [attr1 value1 [attr2 value2...]]
resetDomainSettings - Resetea el límite global de la cuenta, límite de cuenta por COS, y cuota de cuenta del dominio para el dominio seleccionado
                            zxsuite admin resetDomainSettings {domain} 
doShowAdminActivity - Muestra toda la actividad grabada del administrador
                            zxsuite admin doShowAdminActivity [attr1 value1 [attr2 value2...]]
doEnableDisableAdminLogging - Activa o desactiva el registro de las actividades de administración
                            zxsuite admin doEnableDisableAdminLogging {enable|disable} 
setProperty - Establece propiedades de configuración
                            zxsuite admin setProperty {property_name} {property_value} 
getProperty - Muestra propiedades de configuración
                            zxsuite admin getProperty [attr1 value1 [attr2 value2...]]
doMonthlyReport - Genera un reporte de las actividades de administración para un mes especifico
                            zxsuite admin doMonthlyReport [attr1 value1 [attr2 value2...]]
getMonthlyReport - Muestra un reporte de la actividad de administración para un mes específico
                            zxsuite admin getMonthlyReport [attr1 value1 [attr2 value2...]]
doSetZimletRights - Fija los derechos del zimlet ZeXtras para todos los Administradores Delegados
                            zxsuite admin doSetZimletRights 
getAllOperations - Muestra todas las operaciones en curso y en cola
                            zxsuite admin getAllOperations 
doStopAllOperations - Detiene todas las operaciones en curso y vacía la cola de operaciones
                            zxsuite admin doStopAllOperations 
doStopOperation - Detiene una operación en curso
                            zxsuite admin doStopOperation {operation_uuid} 
monitor - Monitorea una operación en curso
                            zxsuite admin monitor {operation_uuid} [attr1 value1 [attr2 value2...]]


Línea de comandos de ZxMig

Vea AQUI

Video Tutorial del CLI de ZeXtras

ZeXtras Backup - Undelete Restore


ZeXtras Backup - Restore on New Account


ZeXtras Backup - Restore on New Account

Personal tools