Get Client Properties By Name

This operation returns the properties associated with a client.

Path Parameters

clientname string required
Name of the client

Responses

application/json

Schema
Example (from schema)

Schema

processinginstructioninfo object
attributes object[]
name string
value string
clientProperties object[]
clusterClientProperties object
configureClusterClient boolean
showAllAgents boolean
pseudoClientInfo object
edgeDrivePseudoClientProperties object
systemDriveType integer
impersonateUser object
outlookAddinStoreInfo object
openVMSProperties object
cvdPort integer
userAccount object
password string
userName string
virtualServerClientProperties object
virtualServerInstanceInfo object
vsInstanceType integer
vmBackupInfo object
distributedClusterInstanceProperties object
clusterConfig object
ibmiInstallOptions object
jobProirity integer
jobQueue string
createJobQueue boolean
subsysDescription string
dataFolder string
runPriority integer
userProfile object
userName string
clientProps object
isMA boolean
webSearchServiceUrl string
AutoUpdateLocation string
JobResultsDiskCapThreshold integer
CipherType integer
RetryFrequencyInSecOnNetworkError integer
isWebServerInstalled boolean
RestoreAccessFlag integer
isRemoteCacheEnabled boolean
SnapBackupMAInstalled boolean
PathToExchangeMiningTool string
is1TouchClient boolean
RestoreAccessSynFull boolean
AltCachePartitionForQSnap string
cacheSource integer
ClientInterface string
EncryptKeyLength integer
isIndexingV2 boolean
IsQsnapUNIX boolean
dm2CacheDiskCapThreshold integer
EnableContentIndexing boolean
OptimizeDataForSearch boolean
recallService string
CenteraResourceFilename string
isQsnapInstalled integer
ContentIndexEngineInstalled boolean
dm2CacheRetentionDays integer
IsDCInstalled boolean
encryptionSettings integer
IsExchangeOnePassClient boolean
isExchangePseudoClient boolean
RetryCountOnNetworkError integer
DirectMediaAccessFlag integer
isPersonalWorkstation boolean
isIndexingV2NAS boolean
JobResultsThresholdMB integer
JobResultsRetentionDays integer
EnableSnapBackups boolean
BlockLevelCacheDir string
StorePatchLocally boolean
isFastSearchSupported boolean
isDescriptionInHTMLFormat boolean
BinarySetID integer
IsCommServer boolean
IsDeletedClient boolean
iswebSearchServerInstalled boolean
EnableCollectDelegateInfo boolean
fileLevelAnalyticsLicense boolean
EnableRetryOnNetworkError boolean
dm2CacheThresholdMB integer
queueJobsIfOtherConflictingJobsAreActive boolean
IsVirtualClient boolean
JobPriority integer
overrideGlobalDesktopGuiProperties boolean
enableAccessControl boolean
CDRLogFileLocation string
EndUserUrl string
ClientNoPhysicalMachine boolean
byteOrder string
RestoreAccessPubKey boolean
networkThrottle object
enableThrottle boolean
throttle object
webSearchServerForSuperSearch object
clientId integer
clientName string
securityAssociations object
associations object[]
userOrGroup object[]
userGroupName string
userGroupId integer
_type_ integer
userId integer
userName string
properties object
isCreatorAssociation boolean
role object
_type_ integer
roleId integer
roleName string
ownerAssociations object
categoryPermission object
categoriesPermissionList object[]
permissionId integer
permissionName string
categoryName string
_type_ integer
categoryId integer
owners object[]
userId integer
_type_ integer
userName string
userGroupName string
userGroupId integer
entityOwners object[]
flags integer
ownerUser object
_type_ integer
userName string
userId integer
ownerUserGroup object
userGroupId integer
_type_ integer
userGroupName string
clientSecurity object
enableDataSecurity boolean
clientUserGroupOwners string[]
clientOwners string[]
associatedUserGroups object[]
userGroupId integer
_type_ integer
userGroupName string
ownerCapabilities object
individualCapabilities integer[]
registryKeys object[]
relativepath string
keyName string
isInheritedFromClientGroup boolean
comment string
type string
value string
enabled integer
sourceEntity object
dlpPropertise object
dlpScanIntervalMins integer
dlpStolen boolean
dlpEnableAutomaticDecryption boolean
dlpUnlockMethod integer
enableDLP boolean
dlpEnableClientKeys boolean
dlpMinFileAgeMins integer
dlpRMProperties object
enableRmDLP boolean
dlpRmNow boolean
dlpRmOfflineDays integer
firewallConfiguration object
configureFirewallSettings boolean
isTrivialConfig boolean
reachMeVia object
reachMeViaSelected boolean
fwTrivialConfig object
firewallTrivialDetailsCS object
networkType integer
connectionType integer
proxyEntity object
clientName string
clientId integer
firewallTrivialDetailsMA object
networkType integer
connectionType integer
proxyEntity object
clientName string
clientId integer
firewallOptions object
isRoamingClient boolean
extendedProperties string
tunnelconnectionPort integer
foreceSSL boolean
tunnelInitSeconds integer
lockdown boolean
bindOpenPortsOnly boolean
isDMZ boolean
keepAliveSeconds integer
tppm object[]
deDuplicationProperties object
performClientSideDeduplication boolean
enableHighLatencyOptimization boolean
cacheBufferSize integer
maxCacheDb integer
clientSideDeduplication integer
enableVariableContentAlignment boolean
enableClientSideDiskCache boolean
spWebServerProperties object
enableOnlineSearch boolean
spWebServerUserPassword object
activityControl object
EnableDataRecovery boolean
EnableDataManagement boolean
EnableOnlineContentIndex boolean
advancedClientProperties object
slaCopyFallenBehindDays integer
rpoMinutes integer
mailServerRole integer
rtoMinutes integer
slaCopyRedundancy integer
excludeFromSLA boolean
dm2CacheDir object
path string
userAccount object
userName string
rightManagementServiceProperties object
SMTPAddressOfTheRMSSuperUser string
decryptRMSDocumentDuringContentIndexing boolean
smtpAddressOfRMSSuperUser string
rmsCredentials object
password string
userName string
clientActivityControl object
activityControlOptions object[]
activityType integer
enableAfterADelay boolean
enableActivityType boolean
jobThrottleSettings object
isJobThrottleEnabledAtCS integer
isJobThrottleEnabled integer
dataThreshold integer
excludeImmidiateJobs integer
logThreshold integer
webSearchServer object
hostName string
clientId integer
emailWebAppProperties object
enableEmailWebApp boolean
exchangeAdminSmtpAddress string
exchangeAdministratorAccount object
userName string
client object
displayName string
installDirectory string
ClockSkewInSeconds integer
timezoneSetByUser boolean
clientDescription string
evmgrcPort integer
cvdPort integer
jobResulsDir object
path string
userAccount object
userName string
origCommCell object
commCellId integer
clientEntity object
hostName string
clientId integer
clientName string
commCellName string
clientGUID string
versionInfo object
UpdateStatus integer
version string
GalaxyRelease object
ReleaseString string
PatchStatus object[]
BaselineUpdates string
BaselineStatus integer
packageInfo object
packageId integer
packageName string
TimeZone object
TimeZoneID integer
TimeZoneName string
osInfo object
Type string
SubType string
osId integer
OsDisplayInfo object
ProcessorType string
OSName string
clientGroups object[]
clientGroupId integer
clientGroupName string
AdvancedFeatures object[]
LicenseName string
LicenseId integer
ActivePhysicalNode object
hostName string
clientId integer
clientName string

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "clientProperties": [
    {
      "clusterClientProperties": {
        "configureClusterClient": true,
        "showAllAgents": true
      },
      "pseudoClientInfo": {
        "edgeDrivePseudoClientProperties": {
          "systemDriveType": 0,
          "impersonateUser": {},
          "outlookAddinStoreInfo": {}
        },
        "openVMSProperties": {
          "cvdPort": 0,
          "userAccount": {
            "password": "string",
            "userName": "string"
          }
        },
        "virtualServerClientProperties": {
          "virtualServerInstanceInfo": {
            "vsInstanceType": 0
          },
          "vmBackupInfo": {}
        },
        "distributedClusterInstanceProperties": {
          "clusterConfig": {}
        },
        "ibmiInstallOptions": {
          "jobProirity": 0,
          "jobQueue": "string",
          "createJobQueue": true,
          "subsysDescription": "string",
          "dataFolder": "string",
          "runPriority": 0,
          "userProfile": {
            "userName": "string"
          }
        }
      },
      "clientProps": {
        "isMA": true,
        "webSearchServiceUrl": "string",
        "AutoUpdateLocation": "string",
        "JobResultsDiskCapThreshold": 0,
        "CipherType": 0,
        "RetryFrequencyInSecOnNetworkError": 0,
        "isWebServerInstalled": true,
        "RestoreAccessFlag": 0,
        "isRemoteCacheEnabled": true,
        "SnapBackupMAInstalled": true,
        "PathToExchangeMiningTool": "string",
        "is1TouchClient": true,
        "RestoreAccessSynFull": true,
        "AltCachePartitionForQSnap": "string",
        "cacheSource": 0,
        "ClientInterface": "string",
        "EncryptKeyLength": 0,
        "isIndexingV2": true,
        "IsQsnapUNIX": true,
        "dm2CacheDiskCapThreshold": 0,
        "EnableContentIndexing": true,
        "OptimizeDataForSearch": true,
        "recallService": "string",
        "CenteraResourceFilename": "string",
        "isQsnapInstalled": 0,
        "ContentIndexEngineInstalled": true,
        "dm2CacheRetentionDays": 0,
        "IsDCInstalled": true,
        "encryptionSettings": 0,
        "IsExchangeOnePassClient": true,
        "isExchangePseudoClient": true,
        "RetryCountOnNetworkError": 0,
        "DirectMediaAccessFlag": 0,
        "isPersonalWorkstation": true,
        "isIndexingV2NAS": true,
        "JobResultsThresholdMB": 0,
        "JobResultsRetentionDays": 0,
        "EnableSnapBackups": true,
        "BlockLevelCacheDir": "string",
        "StorePatchLocally": true,
        "isFastSearchSupported": true,
        "isDescriptionInHTMLFormat": true,
        "BinarySetID": 0,
        "IsCommServer": true,
        "IsDeletedClient": true,
        "iswebSearchServerInstalled": true,
        "EnableCollectDelegateInfo": true,
        "fileLevelAnalyticsLicense": true,
        "EnableRetryOnNetworkError": true,
        "dm2CacheThresholdMB": 0,
        "queueJobsIfOtherConflictingJobsAreActive": true,
        "IsVirtualClient": true,
        "JobPriority": 0,
        "overrideGlobalDesktopGuiProperties": true,
        "enableAccessControl": true,
        "CDRLogFileLocation": "string",
        "EndUserUrl": "string",
        "ClientNoPhysicalMachine": true,
        "byteOrder": "string",
        "RestoreAccessPubKey": true,
        "networkThrottle": {
          "enableThrottle": true,
          "throttle": {}
        },
        "webSearchServerForSuperSearch": {
          "clientId": 0,
          "clientName": "string"
        },
        "securityAssociations": {
          "associations": [
            {
              "userOrGroup": [
                {
                  "userGroupName": "string",
                  "userGroupId": 0,
                  "_type_": 0,
                  "userId": 0,
                  "userName": "string"
                }
              ],
              "properties": {
                "isCreatorAssociation": true,
                "role": {
                  "_type_": 0,
                  "roleId": 0,
                  "roleName": "string"
                }
              }
            }
          ],
          "ownerAssociations": {
            "categoryPermission": {
              "categoriesPermissionList": [
                {
                  "permissionId": 0,
                  "permissionName": "string",
                  "categoryName": "string",
                  "_type_": 0,
                  "categoryId": 0
                }
              ]
            },
            "owners": [
              {
                "userId": 0,
                "_type_": 0,
                "userName": "string",
                "userGroupName": "string",
                "userGroupId": 0
              }
            ],
            "entityOwners": [
              {
                "flags": 0,
                "ownerUser": {
                  "_type_": 0,
                  "userName": "string",
                  "userId": 0
                },
                "ownerUserGroup": {
                  "userGroupId": 0,
                  "_type_": 0,
                  "userGroupName": "string"
                }
              }
            ]
          }
        },
        "clientSecurity": {
          "enableDataSecurity": true,
          "clientUserGroupOwners": [
            "string"
          ],
          "clientOwners": [
            "string"
          ],
          "associatedUserGroups": [
            {
              "userGroupId": 0,
              "_type_": 0,
              "userGroupName": "string"
            }
          ],
          "ownerCapabilities": {
            "individualCapabilities": [
              0
            ]
          }
        },
        "registryKeys": [
          {
            "relativepath": "string",
            "keyName": "string",
            "isInheritedFromClientGroup": true,
            "comment": "string",
            "type": "string",
            "value": "string",
            "enabled": 0,
            "sourceEntity": {}
          }
        ],
        "dlpPropertise": {
          "dlpScanIntervalMins": 0,
          "dlpStolen": true,
          "dlpEnableAutomaticDecryption": true,
          "dlpUnlockMethod": 0,
          "enableDLP": true,
          "dlpEnableClientKeys": true,
          "dlpMinFileAgeMins": 0,
          "dlpRMProperties": {
            "enableRmDLP": true,
            "dlpRmNow": true,
            "dlpRmOfflineDays": 0
          }
        },
        "firewallConfiguration": {
          "configureFirewallSettings": true,
          "isTrivialConfig": true,
          "reachMeVia": {
            "reachMeViaSelected": true
          },
          "fwTrivialConfig": {
            "firewallTrivialDetailsCS": {
              "networkType": 0,
              "connectionType": 0,
              "proxyEntity": {
                "clientName": "string",
                "clientId": 0
              }
            },
            "firewallTrivialDetailsMA": {
              "networkType": 0,
              "connectionType": 0,
              "proxyEntity": {
                "clientName": "string",
                "clientId": 0
              }
            }
          },
          "firewallOptions": {
            "isRoamingClient": true,
            "extendedProperties": "string",
            "tunnelconnectionPort": 0,
            "foreceSSL": true,
            "tunnelInitSeconds": 0,
            "lockdown": true,
            "bindOpenPortsOnly": true,
            "isDMZ": true,
            "keepAliveSeconds": 0,
            "tppm": [
              {}
            ]
          }
        },
        "deDuplicationProperties": {
          "performClientSideDeduplication": true,
          "enableHighLatencyOptimization": true,
          "cacheBufferSize": 0,
          "maxCacheDb": 0,
          "clientSideDeduplication": 0,
          "enableVariableContentAlignment": true,
          "enableClientSideDiskCache": true
        },
        "spWebServerProperties": {
          "enableOnlineSearch": true,
          "spWebServerUserPassword": {}
        },
        "activityControl": {
          "EnableDataRecovery": true,
          "EnableDataManagement": true,
          "EnableOnlineContentIndex": true
        },
        "advancedClientProperties": {
          "slaCopyFallenBehindDays": 0,
          "rpoMinutes": 0,
          "mailServerRole": 0,
          "rtoMinutes": 0,
          "slaCopyRedundancy": 0,
          "excludeFromSLA": true
        },
        "dm2CacheDir": {
          "path": "string",
          "userAccount": {
            "userName": "string"
          }
        },
        "rightManagementServiceProperties": {
          "SMTPAddressOfTheRMSSuperUser": "string",
          "decryptRMSDocumentDuringContentIndexing": true,
          "smtpAddressOfRMSSuperUser": "string",
          "rmsCredentials": {
            "password": "string",
            "userName": "string"
          }
        },
        "clientActivityControl": {
          "activityControlOptions": [
            {
              "activityType": 0,
              "enableAfterADelay": true,
              "enableActivityType": true
            }
          ]
        },
        "jobThrottleSettings": {
          "isJobThrottleEnabledAtCS": 0,
          "isJobThrottleEnabled": 0,
          "dataThreshold": 0,
          "excludeImmidiateJobs": 0,
          "logThreshold": 0
        },
        "webSearchServer": {
          "hostName": "string",
          "clientId": 0
        },
        "emailWebAppProperties": {
          "enableEmailWebApp": true,
          "exchangeAdminSmtpAddress": "string",
          "exchangeAdministratorAccount": {
            "userName": "string"
          }
        }
      },
      "client": {
        "displayName": "string",
        "installDirectory": "string",
        "ClockSkewInSeconds": 0,
        "timezoneSetByUser": true,
        "clientDescription": "string",
        "evmgrcPort": 0,
        "cvdPort": 0,
        "jobResulsDir": {
          "path": "string",
          "userAccount": {
            "userName": "string"
          }
        },
        "origCommCell": {
          "commCellId": 0
        },
        "clientEntity": {
          "hostName": "string",
          "clientId": 0,
          "clientName": "string",
          "commCellName": "string",
          "clientGUID": "string"
        },
        "versionInfo": {
          "UpdateStatus": 0,
          "version": "string",
          "GalaxyRelease": {
            "ReleaseString": "string"
          },
          "PatchStatus": [
            {
              "BaselineUpdates": "string",
              "BaselineStatus": 0,
              "packageInfo": {
                "packageId": 0,
                "packageName": "string"
              }
            }
          ]
        },
        "TimeZone": {
          "TimeZoneID": 0,
          "TimeZoneName": "string"
        },
        "osInfo": {
          "Type": "string",
          "SubType": "string",
          "osId": 0,
          "OsDisplayInfo": {
            "ProcessorType": "string",
            "OSName": "string"
          }
        }
      },
      "clientGroups": [
        {
          "clientGroupId": 0,
          "clientGroupName": "string"
        }
      ],
      "AdvancedFeatures": [
        {
          "LicenseName": "string",
          "LicenseId": 0
        }
      ],
      "ActivePhysicalNode": {
        "hostName": "string",
        "clientId": 0,
        "clientName": "string"
      }
    }
  ]
}

Get Client Properties By Name​

Get Client Properties By Name