REST API - GET Client Properties

Description

This operation returns the properties associated with a client.

Request

Syntax

GET SearchSvc/CVWebService.svc/Client/{clientId} HTTP/1.1
Host: <web server host name>
Accept: application/xml
Authtoken: <authentication token>

Request Parameters

Name Description Required
clientId The client ID for the client. If the client ID is not known, use the GET Client API to retrieve it. Yes

Request Headers

Name Description
Host The host name of the web server.
Accept The format of the response. Valid values are: application/xml or application/json.
Authtoken The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

XML

An .xml file is not needed.

Response

Response Parameters

Name Description Elements
clientId The system-generated ID assigned to the client. ActivePhysicalNode
clientName The name of the client. ActivePhysicalNode
hostName The long name of the client, for example, client.domain.company.com. ActivePhysicalNode
LicenseId The code for the license in the LicenseName parameter. AdvancedFeatures
LicenseName The name of the license, for example, "Compliance Search." AdvancedFeatures
ClockSkewInSeconds The difference in time between the client and the CommServe computer. client
clientDescription A general description of the client. client
cvdPort The TCP port number for the Communications Service (CVD). client
evmgrcPort The TCP port number for the Client Event Manager Service (EvMgrC). client
installDirectory The directory where the base software and/or iDataAgent is installed. client
TimeZoneName The time zone used by the client.

Sample values:

  • (UTC) Coordinated Universal Time
  • (UTC-05:00) Eastern Time (US & Canada)
TimeZone
clientId The system-generated ID assigned to the client. clientEntity
clientName The name of the client. clientEntity
commCellName The name of the CommCell. clientEntity
hostName The long name of the client, for example, client.domain.company.com. clientEntity
path The directory where the job results reside. jobResulsDir
userName The name of the user. userAccount
commCellId The CommCell ID of the CommServe. origCommCell
SubType Information about the operating system. osInfo
Type Information about the operating system. osInfo
osId Information about the operating system. osInfo
OSName The operating system, for example, Windows Server 2008 R2 Enterprise. OsDisplayInfo
ProcessorType The processor of the computer, for example, WinX64. OsDisplayInfo
UpdateStatus Additional information about the software updates. versionInfo
version The software version installed. versionInfo
ReleaseString Additional information about the software updates. GalaxyRelease
BaselineStatus Additional information about the software updates. PatchStatus
BaselineUpdates Additional information about the software updates. PatchStatus
packageName The name of the package, for example, File System Core. packageInfo
clientGroupId The system-generated ID assigned to the client computer group associated with the client. clientGroups
clientGroupName The name of the client computer group associated with the client. clientGroups
AutoUpdateLocation   clientProps
BinarySetID   clientProps
CPUCount The number of CPUs. clientProps
CipherType The cipher to use for data encryption.

Valid values are:

  • 3-DES
  • AES (Rijndael)
  • Blowfish
  • GOST
  • Serpent
  • TwoFish
clientProps
ClientInterface   clientProps
ClientNoPhysicalMachine Valid values are True/False. clientProps
ContentIndexEngineInstalled Indicates whether a content indexing engine is installed.

Valid values are True/False.

clientProps
DirectMediaAccessFlag The storage option for the data encryption key.

Valid values are:

  • Regular, for Via Media Password
  • ViaPassPhrase, for Via Pass Phrase
  • None, for No Access
clientProps
EnableCollectDelegateInfo Valid values are True/False. clientProps
EnableContentIndexing The option to enable content indexing.

Valid values are True/False.

clientProps
EnableEncryption The option to enable data encryption.

Valid values are True/False.

clientProps
EnableRetryOnNetworkError The option to enable retry on network errors.

Valid values are True/False.

clientProps
EnableSnapBackups The option to enable snap backups.

Valid values are True/False.

clientProps
EncryptKeyLength The key length to use with the cipher in the CipherType parameter.

Valid values are:

3-DES cipher

  • 192

AES (Rijndael), Blowfish, Serpent, and TwoFish ciphers

  • 128
  • 256
clientProps
EndUserUrl The URL end users use to access the Web Console. clientProps
IsCommServer Valid values are True/False. clientProps
IsDCInstalled Valid values are True/False. clientProps
IsDeletedClient Valid values are True/False. clientProps
IsQsnapUNIX Valid values are True/False. clientProps
IsVirtualClient Valid values are True/False. clientProps
JobPriority The job priority.

Valid values are 0 to 9.

clientProps
JobResultsDiskCapThreshold The percentage of disk capacity that is reached before job results are pruned. clientProps
JobResultsRetentionDays The number of days to retain job results. clientProps
JobResultsThresholdMB The low space threshold in MB for the job results folder. clientProps
OptimizeDataForSearch The option to optimize data for searching.

Valid values are True/False.

clientProps
RestoreAccessFlag The storage and accessibility of data encryption keys in the CommServe database.

Valid values are:

  • Regular, for storing keys scrambled in the CommServe database
  •  WithPassPhase, for storing keys locked with a user-supplied pass-phrase in the CommServe database

If you are using "WithPassPhase," the DirectMediaAccessFlag parameter must be set to "ViaPassPhrase."

clientProps
RestoreAccessPubKey Valid values are True/False. clientProps
RestoreAccessSynFull Valid values are True/False. clientProps
RetryCountOnNetworkError The number of times the Job Manager checks for network connectivity. Use this parameter when the EnableRetryOnNetworkError parameter is set to "true." clientProps
RetryFrequencyInSecOnNetworkError The interval (in seconds) the Job Manager checks for network connectivity. Use this parameter when the EnableRetryOnNetworkError parameter is set to "true." clientProps
SnapBackupMAInstalled Valid values are True/False. clientProps
StorePatchLocally Valid values are True/False. clientProps
byteOrder   clientProps
cacheSource The source of the cache.

Valid values are:

  • COMMSERVE
  • UPDATEAGENT
clientProps
enableAccessControl This option to enable access control.

Valid values are True/False.

clientProps
fileLevelAnalyticsLicense Valid values are True/False. clientProps
isFastSearchSupported Valid values are True/False. clientProps
isMA Valid values are True/False. clientProps
isRemoteCacheEnabled Indicates whether the remote cache is enabled.

Valid values are True/False.

clientProps
isWebServerInstalled Indicates whether a web server is installed.

Valid values are True/False.

clientProps
iswebSearchServerInstalled Indicates whether a web search server is installed.

Valid values are True/False.

clientProps
overrideGlobalDesktopGuiProperties Valid values are True/False. clientProps
webSearchServiceUrl The URL for the web search server. clientProps
EnableDataManagement The option to enable data management.

Valid values are True/False.

activityControl
EnableDataRecovery The option to enable data recovery.

Valid values are True/False.

activityControl
EnableOnlineContentIndex The option to enable online content indexing.

Valid values are True/False.

activityControl
activityType The client activities.

Valid values are:

  • 1, for backup
  • 2, for restore
  • 4, for auxiliary copy
  • 8, for disaster recovery backup
  • 16, archive pruning
  • 32, for media recycle
  • 64, for synthetic full
  • 28, all activity
  • 256, for schedule
  • 512, for online content indexing
  • 1024, for offline content indexing
activityControlOptions
enableActivityType The option to enable or disable an activity for a client.

Valid values are True/False.

activityControlOptions
enableAfterADelay The option to enable an activity for a client on a date and time defined in the Enable Backup dialog box.

Valid values are True/False.

activityControlOptions
TimeZoneID The code for the time zone in the TimeZoneName parameter. dateTime
TimeZoneName The time zone to use when the Enable after a Delay option is used with an activity. Use this parameter when the enableAfterADelay parameter is set to "true."

Sample values:

  • (UTC) Coordinated Universal Time
  • (UTC-05:00) Eastern Time (US & Canada)
dateTime
_type_ The CommCell objects associated with the activation of the activity.

Valid value is DATE_TIME.

dateTime
time   dateTime
timeValue The date and time to use when the Enable after a Delay option is used with an activity. Use this parameter when the enableAfterADelay parameter is set to "true."

Sample values:

  • 2013-12-11 09:22:32
  • 2014-01-01 17:22:32
dateTime
_type_ The CommCell objects associated with the client security.

Valid value is USERGROUP_ENTITY.

associatedUserGroups
userGroupId The system-generated ID assigned to the user group associated with the client. associatedUserGroups
userGroupName The name of the user group associated with the client. associatedUserGroups
ownerCapabilities The capabilities of the client computer owners associated with the client. clientSecurity
cacheBufferSize The option to set the cache buffer size. deDuplicationProperties
clientSideDeduplication The option to enable Client Side Deduplication.

Valid values are:

  • USE_SPSETTINGS, to use storage policy settings
  • ON_CLIENT, to enable client side deduplication
  • OFF, to disable client side deduplication
deDuplicationProperties
enableClientSideDiskCache The option to enable a client side disk cache. Use this parameter when the clientSideDeduplication parameter is set to "ON_CLIENT."

Valid values are True/False.

deDuplicationProperties
enableHighLatencyOptimization The option to enable high latency optimization. Use this parameter when the enableClientSideDiskCache parameter is set to "true."

Valid values are True/False.

deDuplicationProperties
enableVariableContentAlignment The option to enable variable content alignment.

Valid values are True/False.

deDuplicationProperties
maxCacheDb The option to set the maximum size in megabytes for the cache database .

Use this parameter when the enableClientSideDiskCache parameter is set to "true."

Valid values are:

  • 1024
  • 2048
  • 4096
  • 8192
  • 16384
  • 32768
  • 65536
  • 131072
deDuplicationProperties
performClientSideDeduplication The option to enable source side deduplication.

Valid values are True/False.

deDuplicationProperties
dlpEnableClientKeys The option to unlock files before backups are performed and to allow users to open locked files without entering a pass-key.

Valid values are True/False.

dlpPropertise
dlpMinFileAgeMins The age in minutes of a document (created or modified) before it is locked during a DLP scan. dlpPropertise
dlpScanIntervalMins The number of minutes the DLP scan waits between scans for new or unlocked content. dlpPropertise
dlpStolen The option to mark the client as stolen.

Valid values are True/False.

dlpPropertise
enableDLP The option to enable Data Loss Prevention (DLP).

Valid values are True/False.

dlpPropertise
val The path to the content that should be locked when the DLP scan runs. dlpContents
val The paths or file extensions that should not be locked when the DLP scan runs, for example, *.dll. dlpFilters
dlpRmNow The option to erase the files listed in the val parameter in the dlpRmFilters element. This action is irreversible.

Valid values are True/False.

dlpRMProperties
dlpRmOfflineDays The number of days a client must be offline before files are erased. dlpRMProperties
enableRmDLP The option to enable the Secure Erase feature of Data Loss Prevention (DLP).

Valid values are True/False.

dlpRMProperties
val The path to the content that will be deleted when Secure Erase is activated. dlpRmContent
val The paths or file extensions that should not be deleted  when Secure Erase is activated, for example, *.exe. dlpRmFilters
configureFirewallSettings The settings related to Firewall Configuration.

Valid values are True/False.

firewallConfiguration
isTrivialConfig The settings related to Firewall Configuration.

Valid values are True/False.

firewallConfiguration
bindOpenPortsOnly The settings related to Firewall Configuration.

Valid values are True/False.

firewallOptions
extendedProperties The attribute is a string built using the following: version, encoding, standalone, App_FirewallExtendedProperties, and defaultOutgoingProtocol. For example, extendedProperties="&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; standalone=&quot;no&quot; ?>&lt;App_FirewallExtendedProperties defaultOutgoingProtocol=&quot;0&quot;/>" firewallOptions
foreceSSL The settings related to Firewall Configuration.

Valid values are True/False.

firewallOptions
isDMZ The settings related to Firewall Configuration.

Valid values are True/False.

firewallOptions
isRoamingClient The settings related to Firewall Configuration.

Valid values are True/False.

firewallOptions
keepAliveSeconds The settings related to Firewall Configuration. firewallOptions
lockdown The settings related to Firewall Configuration.

Valid values are True/False.

firewallOptions
tunnelInitSeconds The settings related to Firewall Configuration. firewallOptions
tunnelconnectionPort The settings related to Firewall Configuration. firewallOptions
tppm The settings related to Firewall Configuration. firewallOptions
fwTrivialConfig The settings related to Firewall Configuration. firewallConfiguration
connectionType The settings related to Firewall Configuration. firewallTrivialDetailsCS
networkType The settings related to Firewall Configuration. firewallTrivialDetailsCS
clientId The system-generated ID assigned to the client. proxyEntity
clientName The name of the client. proxyEntity
connectionType The settings related to Firewall Configuration. firewallTrivialDetailsMA
networkType The settings related to Firewall Configuration. firewallTrivialDetailsMA
enableThrottle The option to use network throttling. For information on network throttling, see Configuring Network Throttling.

Valid values are True/False.

networkThrottle
throttle The settings related to Network Throttle. networkThrottle
deleted The options related to Additional Settings. registryKeys
enabled The options related to Additional Settings. registryKeys
isInheritedFromClientGroup The options related to Additional Settings. registryKeys
keyName The options related to Additional Settings. registryKeys
relativepath The options related to Additional Settings. registryKeys
type The options related to Additional Settings. registryKeys
value The options related to Additional Settings. registryKeys
decryptRMSDocumentDuringContentIndexing The option to decrypt an RMS (Rights Management Services) document during content indexing.

Valid values are True/False.

rightManagementServiceProperties
rmsCredentials The credentials for RMS (Rights Management Services). rightManagementServiceProperties
enableOnlineSearch The option to enable online searching.

Valid values are True/False.

spWebServerProperties
spWebServerUserPassword   spWebServerProperties
clientId The system-generated ID assigned to the client. webSearchServer
hostName The long name of the client, for example, client.domain.company.com. webSearchServer
configureClusterClient The option to enable the cluster group configuration.

Valid values are True/False.

clusterClientProperties
showAllAgents The option to show all agents.

Valid values are True/False.

clusterClientProperties
cvdPort The TCP port number for the Communications Service (CVD). openVMSProperties
userName The name of the user. userAccount

Examples

Sample Request

GET SearchSvc/CVWebService.svc/Client/2 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

This response is available as an XML file: get_client_properties_response.xml.

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_GetClientPropertiesResponse>
<clientProperties>
    <ActivePhysicalNode clientId="2" clientName="client001" hostName="client.mydomain.com"/>
    <AdvancedFeatures LicenseId="1" LicenseName="Server File System"/>
    <AdvancedFeatures LicenseId="11" LicenseName="MediaAgent"/>
    <AdvancedFeatures LicenseId="82" LicenseName="Vault Tracker Enterprise"/>
    <AdvancedFeatures LicenseId="84" LicenseName="Media Agent Direct to Disk Option (DDO)"/>
    <AdvancedFeatures LicenseId="85" LicenseName="Data Encryption"/>
    <AdvancedFeatures LicenseId="90" LicenseName="WORM Media Support"/>
    <AdvancedFeatures LicenseId="91" LicenseName="GridStore"/>
    <AdvancedFeatures LicenseId="102" LicenseName="Boot Server on Unix"/>
    <AdvancedFeatures LicenseId="105" LicenseName="Content Addressed Storage"/>
    <AdvancedFeatures LicenseId="110" LicenseName="System Recovery Server on Windows"/>
    <AdvancedFeatures LicenseId="141" LicenseName="Compliance Search"/>
    <AdvancedFeatures LicenseId="142" LicenseName="Legal Hold"/>
    <AdvancedFeatures LicenseId="164" LicenseName="Automated content classification"/>
    <AdvancedFeatures LicenseId="165" LicenseName="Data Tagging"/>
    <AdvancedFeatures LicenseId="168" LicenseName="Block Level De-Duplication"/>
    <AdvancedFeatures LicenseId="174" LicenseName="CommNet Advanced Reporting"/>
    <AdvancedFeatures LicenseId="197" LicenseName="Remote Operation Management Service"/>
    <AdvancedFeatures LicenseId="203" LicenseName="Protected Mailboxes"/>
    <AdvancedFeatures LicenseId="100001" LicenseName="Data Protection Core infrastructure"/>
    <AdvancedFeatures LicenseId="100002" LicenseName="Data Protection Enterprise infrastructure"/>
    <AdvancedFeatures LicenseId="100003" LicenseName="Data Archive Core infrastructure"/>
    <AdvancedFeatures LicenseId="100004" LicenseName="Data Archive Enterprise infrastructure"/>
    <AdvancedFeatures LicenseId="16777216" LicenseName="CommClient Base"/>
    <AdvancedFeatures LicenseId="50331648" LicenseName="CommServe StorageManager"/>
    <client ClockSkewInSeconds="-15" clientDescription="client-level description" cvdPort="8400" evmgrcPort="8402" installDirectory="C:\\Program Files\MyCompany\Simpana\">
      <TimeZone TimeZoneName="(UTC-05:00) Eastern Time (US &amp; Canada)"/>
      <clientEntity clientId="2" clientName="client001" commCellName="client.mydomain.com" hostName="client.mydomain.com"/>
      <jobResulsDir path="C:\Program Files\MyCompany\Simpana\iDataAgent\JobResults">
        <userAccount/>
      </jobResulsDir>
      <origCommCell commCellId="0"/>
      <osInfo SubType="Server" Type="Windows" osId="210">
        <OsDisplayInfo OSName="Windows Server 2008 R2 Enterprise" ProcessorType="WinX64"/>
      </osInfo>
      <versionInfo UpdateStatus="HAS_DIAGNOSTIC_UPDATES" version="ServicePack:4,AdditionalUpdates:,5603,6217,6231,6300,6335,PreRelease-5541-GUI">
        <GalaxyRelease ReleaseString="10"/>
        <PatchStatus BaselineStatus="AHEAD_OF_CACHE" BaselineUpdates="SP4">
          <packageInfo packageName="File System Core"/>
        </PatchStatus>
      </versionInfo>
    </client>
    <clientGroups clientGroupId="1" clientGroupName="Media Agents"/>
    <clientProps AutoUpdateLocation="C:\Program Files\MyCompany\Simpana\" BinarySetID="3" CPUCount="2" CipherType="BLOWFISH" ClientInterface="client.mydomain.com" ClientNoPhysicalMachine="false" ContentIndexEngineInstalled="false" DirectMediaAccessFlag="Regular" EnableCollectDelegateInfo="true" EnableContentIndexing="false" EnableEncryption="false" EnableRetryOnNetworkError="true" EnableSnapBackups="false" EncryptKeyLength="128" EndUserUrl="http://client.mydomain.com:80/webconsole" IsCommServer="true" IsDCInstalled="false" IsDeletedClient="false" IsQsnapUNIX="false" IsVirtualClient="false" JobPriority="6" JobResultsDiskCapThreshold="90" JobResultsRetentionDays="7" JobResultsThresholdMB="500" OptimizeDataForSearch="false" RestoreAccessFlag="Regular" RestoreAccessPubKey="false" RestoreAccessSynFull="false" RetryCountOnNetworkError="40" RetryFrequencyInSecOnNetworkError="30" SnapBackupMAInstalled="true" StorePatchLocally="true" byteOrder="Little-endian" cacheSource="COMMSERVE" enableAccessControl="true" fileLevelAnalyticsLicense="false" isFastSearchSupported="false" isMA="true" isRemoteCacheEnabled="true" isWebServerInstalled="true" iswebSearchServerInstalled="true" overrideGlobalDesktopGuiProperties="false" webSearchServiceUrl="http://client.mydomain.com:81/SearchSvc">
      <activityControl EnableDataManagement="true" EnableDataRecovery="false" EnableOnlineContentIndex="false"/>
      <clientActivityControl>
        <activityControlOptions activityType="BACKUP" enableActivityType="true" enableAfterADelay="false"/>
        <activityControlOptions activityType="RESTORE" enableActivityType="false" enableAfterADelay="false"/>
        <activityControlOptions activityType="ONLINECI" enableActivityType="false" enableAfterADelay="false"/>
      </clientActivityControl>
      <clientSecurity>
        <associatedUserGroups _type_="USERGROUP_ENTITY" userGroupId="1" userGroupName="master"/>
        <associatedUserGroups _type_="USERGROUP_ENTITY" userGroupId="3" userGroupName="View All"/>
        <ownerCapabilities/>
      </clientSecurity>
      <deDuplicationProperties cacheBufferSize="1024" clientSideDeduplication="USE_SPSETTINGS" enableClientSideDiskCache="false" enableHighLatencyOptimization="false" enableVariableContentAlignment="false" maxCacheDb="4096" performClientSideDeduplication="true"/>
      <dlpPropertise dlpEnableClientKeys="false" dlpMinFileAgeMins="5" dlpScanIntervalMins="15" dlpStolen="false" enableDLP="false"/>
      <firewallConfiguration configureFirewallSettings="false" isTrivialConfig="false">
        <firewallOptions bindOpenPortsOnly="false" extendedProperties="&lt;App_FirewallExtendedProperties defaultOutgoingProtocol=&quot;0&quot; />" foreceSSL="false" isDMZ="false" isRoamingClient="false" keepAliveSeconds="600" lockdown="false" tunnelInitSeconds="30" tunnelconnectionPort="8403">
          <tppm/>
        </firewallOptions>
        <fwTrivialConfig>
          <firewallTrivialDetailsCS connectionType="OPEN_TUNNEL_DIRECTLY" networkType="ALWAYS_SAME_NETWORK">
            <proxyEntity clientId="1" clientName="NO CLIENT"/>
          </firewallTrivialDetailsCS>
          <firewallTrivialDetailsMA connectionType="OPEN_TUNNEL_DIRECTLY" networkType="ALWAYS_SAME_NETWORK">
            <proxyEntity clientId="1" clientName="NO CLIENT"/>
          </firewallTrivialDetailsMA>
        </fwTrivialConfig>
      </firewallConfiguration>
      <networkThrottle enableThrottle="false">
        <throttle/>
      </networkThrottle>
      <registryKeys deleted="0" enabled="1" isInheritedFromClientGroup="false" keyName="bEnableLogMonitoring" relativepath="CommServDB.Console" type="BOOLEAN" value="true"/>
      <rightManagementServiceProperties decryptRMSDocumentDuringContentIndexing="false">
        <rmsCredentials/>
      </rightManagementServiceProperties>
      <spWebServerProperties enableOnlineSearch="false">
        <spWebServerUserPassword/>
      </spWebServerProperties>
      <webSearchServer clientId="2" hostName="client.mydomain.com"/>
    </clientProps>
    <clusterClientProperties configureClusterClient="false" showAllAgents="false"/>
    <pseudoClientInfo>
      <openVMSProperties cvdPort="8400">
        <userAccount/>
      </openVMSProperties>
    </pseudoClientInfo>
  </clientProperties>
</App_GetClientPropertiesResponse>