class NsServer

La classe NsServer permet d'accéder aux propriétés et aux méthodes générales du serveur de sauvegarde. Seul un administrateur peur charger un objet NsServer en mémoire et accéder à ses membres.

ConnectedUsers : long readonly

Le nombre d'utilisateurs connectés.

OpenedSessions : long readonly

Le nombre total de sessions ouvertes par les utilisateurs connectés.

TotalPhys : __int64 readonly

La quantité de mémoire physique installée sur le poste serveur.

AvailPhys : __int64 readonly

La quantité de mémoire physique disponible sur le posre serveur.

TotalVirtual : __int64 readonly

La quantité de mémoire virtuelle totale vue par le processus serveur.

AvailVirtual : long readonly

La quantité de mémoire virtuelle disponible pour le processus serveur.

PrivateBytes : __int64 readonly

Le nombre d'octets privés alloués par le processus serveur.

WorkingSet : __int64 readonly

Le nombre de mémoire physique totale utilisée par le processus serveur.

NumberOfThreads : long readonly

Le nombre de fils d'exécutions actifs du processus serveur.

InstanceName : BSTR readonly

Le nom de l'instance du serveur de sauvegarde.

SoftwareVersion : BSTR readonly

La version du logiciel serveur.

IsConfigured : VARIANT_BOOL readonly

Une variable booléenne indiquant si le serveur est configuré ou non.

StartDate : VARIANT readonly

La date de démarrage du serveur, au format UTC.

Language : enum NsLanguage readonly

La langue par défaut du serveur de sauvegarde.

KeysStorageOptions : enum NsKeysStorageOptions readonly

La politique de stockage des clés de chiffrement des utilisateurs.

WebInterfaceState : enum NsWebInterfaceState readonly

L'état d'activation de l'interface Web.

WebInterfacePublishedURL : BSTR readonly

L'URL de publication de l'interface Web.

SharedFilesMaxSize : __int64 readonly

La taille maximum des fichiers partagés, si la fonction est activée côté serveur.

TimeResolution : long readonly

Le nombre de jours pendant lequel conserver les rapports de sauvegarde et les informations d'exécution.

HWCollectingMode : enum NsHardwareCollectingMode readonly

Le mode de collecte et d'analyse des informations matérielles des postes client.

DbVersion : long readonly

L'identificateur de révision de la base de données.

DbLastOptimizationDate : VARIANT readonly

La date de dernière optimisation de la base, au format UTC.

DbInSweep : VARIANT_BOOL readonly

Une variable booléenne indiquant si une procédure de maintenance automatique de la base de données est en cours d'exécution ou non.

DbServer : BSTR readonly

L'IP ou l'hôte du serveur de base de données.

DbFilePath : BSTR readonly

Le chemin d'accès à la base de données.

DbFileSize : __int64 readonly

La taille de la base de données.

DbVHDFilePath : BSTR readonly

Le chemin d'accès au disque VHD contenant la base de données, le cas échéant.

DbPoolSize : long readonly

La taille du pool des connections à la base de données.

DbPoolCurrentUsage : long readonly

Le nombre de connexions actives actuellement poolées.

DbPoolMaxUsage : long readonly

Le nombre maximum de connexions poolées par le serveur à ce jour.

StoredReportsSize : __int64 readonly

La taille des rapports de sauvegarde stockés en base de données.

VARIANT_BOOL Load(NsConnection Connection)

Charge en mémoire l'objet serveur.

VARIANT_BOOL GetState(NsConnection Connection, NsServerState State)

Retourne dans State l'état actuel du serveur.

VARIANT_BOOL ChangeState(NsConnection Connection, NsServerState State)

Définit le nouvel état serveur spécifié par State. Les valeurs acceptées pour State sont nsServerStateRunning pour la sortie ou l'annulation d'un passage en maintenance, et nsServerStateMaintenance pour une demande de passage en mode maintenance.

VARIANT_BOOL GetServerConfigFile(NsConnection Connection, BSTR FilePath)

Télécharge le fichier de configuration serveur et le dépose à l'emplacement local spécifié par le paramètre FilePath.

VARIANT_BOOL SetServerConfigFile(NsConnection Connection, BSTR FilePath)

Remplace le fichier de configuration serveur par le fichier présent à l'emplacement local spécifié par le paramètre FilePath.

VARIANT_BOOL GetServerLogFile(NsConnection Connection, NsServerLogType LogType, BSTR FilePath)

Place à l'emplacement local spécifié par FilePath le journal serveur de type LogType.

VARIANT_BOOL ClearServerLog(NsConnection Connection, NsServerLogType LogType)

Réinitialise le journal serveur de type LogType.

VARIANT_BOOL ClearHistory(NsConnection Connection, long DaysToKeep)

Supprime toutes les informations d'exécution datant de plus de DaysToKeep jours.

VARIANT_BOOL BeginBlockCommitsAndRollbacks(NsConnection Connection)

Bloque tout COMMIT et ROLLBACK de la base de données.

VARIANT_BOOL EndBlockCommitsAndRollbacks(NsConnection Connection)

Débloque les COMMIT et ROLLBACK de la base de données.

VARIANT_BOOL IsFeatureSupported(NsConnection Connection, long FeatureID, VARIANT_BOOL IsSupported)

Renvoit un booléen indiquant si la fonctionnalité de code FeatureID est supportée par cette version du serveur de sauvegarde.

NsServerSessionCollection ActiveSessions(NsConnection Connection)

Retourne la liste des sessions actives.

NsServerTransactionCollection ActiveTransactions(NsConnection Connection)

Retourne la liste des transactions actives.

INsRunningLocalBackupCollection RunningLocalBackups(NsConnection Connection)

Retourne la liste des sauvegardes locales en cours d'exécution sur les postes des clients.

NsUserGroupCollection UserGroups(NsConnection Connection)

Retourne l'ensemble des groupes utilisateur paramétrés sur le serveur.

NsStorageCollection StorageAccounts(NsConnection Connection)

Retourne les comptes de stockage paramétrés sur le serveur.

NsSharedFileCollection SharedFiles(NsConnection Connection)

Retourne l'ensemble des fichiers partagés par les utilisateurs du système de sauvegarde.

NsBrokenFileCollection BrokenFiles(NsConnection Connection)

Retourne l'ensemble des transferts en attente de reprise stockés sur le serveur.

NsExecutionRequestCollection ExecutionRequests(NsConnection Connection)

Retourne la liste des demandes d'exécution enregistrées sur le serveur.

NsServerAlertCollection Alerts(NsConnection Connection, VARIANT_BOOL OnlyRaised)

Retourne l'ensemble des alertes programmées sur le serveur. Si le paramètre OnlyRaised possède la valeur true, seul les alertes déclenchées sont retournées.

NsBackupCollection AllBackups(NsConnection Connection)

Retourne toutes les sauvegardes attribuées stockées par le serveur.

NsHistoryCollection History(NsConnection Connection, long Limit)

Retourne les informations d'exécution sur les dernières opérations effectuées. Si le paramètre Limit possède une valeur supérieure à 0, seul les Limit dernières opérations sont retournées.

NsExecPlanCollection ExecPlans(NsConnection Connection)

Retourne les plans d'exécution stockés par le serveur.

NsPerfMonCounterCollection PerfMonCounters(NsConnection Connection)

Charge la liste des compteurs de performances enregistrés sur le serveur.

NsBackupVerificationCollection Verifications(NsConnection Connection)

Retourne la liste des vérifications en cours ou terminées sur le serveur.

NsServerReplicaCollection Replicas(NsConnection Connection)

Retourne la liste des réplicats du serveur de sauvegarde, si la réplication serveur est activée.

NsDataAccessLogEntryCollection DataAccessLogEntries(NsConnection Connection)

Retourne la liste des opérations ayant entraîné l'accès aux données des sauvegardes stockées sur le serveur.

NsPushRestoreRequestCollection PushRestoreRequests(NsConnection Connection)

Renvoit la liste des opérations Push Restore enregistrées sur le serveur.

NsRestorePackageCollection RestorePackages(NsConnection Connection)

Retourne la liste des archives de restauration enregistrées sur le serveur.

NsSearchEngine SearchEngine()

Retourne un objet permettant la recherche dans les fichiers stockés.

VARIANT_BOOL ReloadConfig(NsConnection Connection)

Recharge la configuration serveur.

VARIANT_BOOL ClearCache(NsConnection Connection)

Efface le cache mémoire du serveur de sauvegarde.

VARIANT_BOOL CompactDBPool(NsConnection Connection)

Compacte le pool de connexions à la base de données.

Affichage des informations serveur

Set connection = CreateObject("NsAPI.NsConnection")

if connection.ConnectToLocalServer then
  set server = CreateObject("NsAPI.NsServer")

  if server.Load(connection) then ' Charger les informations serveur
    MsgBox "Connecté à l'instance " & server.InstanceName
    MsgBox "Groupes d'utilisateurs paramétrés : " & server.UserGroups(connection).Count
    MsgBox "Sauvegardes attribuées : " & server.AllBackups(connection).Count
    MsgBox "Fichier partagés : " & server.SharedFiles(connection).Count
    MsgBox "Transferts en attente de reprise : " & server.BrokenFiles(connection).Count
    MsgBox "Demandes d'exécution : " & server.ExecutionRequests(connection).Count
    MsgBox "Alertes déclenchées : " & server.Alerts(connection, true).Count
    MsgBox "Plans d'exécution : " & server.ExecPlans(connection).Count
    MsgBox "Nombre d'opérations stockées : " & server.History(connection, 0).Count
  end if

  connection.Disconnect
else
  MsgBox "Connexion au serveur local impossible."
end if