Get Client Properties By Name
Select
SaaS
Customer Managed
This operation returns the properties associated with a client.
Path Parameters
- clientname string required
Name of the client
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
Schema
processinginstructioninfo object
attributes object[]
name stringvalue stringclientProperties object[]
clusterClientProperties object
configureClusterClient booleanshowAllAgents booleanpseudoClientInfo object
edgeDrivePseudoClientProperties object
systemDriveType integerimpersonateUser object
outlookAddinStoreInfo object
openVMSProperties object
cvdPort integeruserAccount object
password stringuserName stringvirtualServerClientProperties object
virtualServerInstanceInfo object
vsInstanceType integervmBackupInfo object
distributedClusterInstanceProperties object
clusterConfig object
ibmiInstallOptions object
jobProirity integerjobQueue stringcreateJobQueue booleansubsysDescription stringdataFolder stringrunPriority integeruserProfile object
userName stringclientProps object
isMA booleanwebSearchServiceUrl stringAutoUpdateLocation stringJobResultsDiskCapThreshold integerCipherType integerRetryFrequencyInSecOnNetworkError integerisWebServerInstalled booleanRestoreAccessFlag integerisRemoteCacheEnabled booleanSnapBackupMAInstalled booleanPathToExchangeMiningTool stringis1TouchClient booleanRestoreAccessSynFull booleanAltCachePartitionForQSnap stringcacheSource integerClientInterface stringEncryptKeyLength integerisIndexingV2 booleanIsQsnapUNIX booleandm2CacheDiskCapThreshold integerEnableContentIndexing booleanOptimizeDataForSearch booleanrecallService stringCenteraResourceFilename stringisQsnapInstalled integerContentIndexEngineInstalled booleandm2CacheRetentionDays integerIsDCInstalled booleanencryptionSettings integerIsExchangeOnePassClient booleanisExchangePseudoClient booleanRetryCountOnNetworkError integerDirectMediaAccessFlag integerisPersonalWorkstation booleanisIndexingV2NAS booleanJobResultsThresholdMB integerJobResultsRetentionDays integerEnableSnapBackups booleanBlockLevelCacheDir stringStorePatchLocally booleanisFastSearchSupported booleanisDescriptionInHTMLFormat booleanBinarySetID integerIsCommServer booleanIsDeletedClient booleaniswebSearchServerInstalled booleanEnableCollectDelegateInfo booleanfileLevelAnalyticsLicense booleanEnableRetryOnNetworkError booleandm2CacheThresholdMB integerqueueJobsIfOtherConflictingJobsAreActive booleanIsVirtualClient booleanJobPriority integeroverrideGlobalDesktopGuiProperties booleanenableAccessControl booleanCDRLogFileLocation stringEndUserUrl stringClientNoPhysicalMachine booleanbyteOrder stringRestoreAccessPubKey booleannetworkThrottle object
enableThrottle booleanthrottle object
webSearchServerForSuperSearch object
clientId integerclientName stringsecurityAssociations object
associations object[]
userOrGroup object[]
userGroupName stringuserGroupId integer_type_ integeruserId integeruserName stringproperties object
isCreatorAssociation booleanrole object
_type_ integerroleId integerroleName stringownerAssociations object
categoryPermission object
categoriesPermissionList object[]
permissionId integerpermissionName stringcategoryName string_type_ integercategoryId integerowners object[]
userId integer_type_ integeruserName stringuserGroupName stringuserGroupId integerentityOwners object[]
flags integerownerUser object
_type_ integeruserName stringuserId integerownerUserGroup object
userGroupId integer_type_ integeruserGroupName stringclientSecurity object
enableDataSecurity booleanclientUserGroupOwners string[]clientOwners string[]associatedUserGroups object[]
userGroupId integer_type_ integeruserGroupName stringownerCapabilities object
individualCapabilities integer[]registryKeys object[]
relativepath stringkeyName stringisInheritedFromClientGroup booleancomment stringtype stringvalue stringenabled integersourceEntity object
dlpPropertise object
dlpScanIntervalMins integerdlpStolen booleandlpEnableAutomaticDecryption booleandlpUnlockMethod integerenableDLP booleandlpEnableClientKeys booleandlpMinFileAgeMins integerdlpRMProperties object
enableRmDLP booleandlpRmNow booleandlpRmOfflineDays integerfirewallConfiguration object
configureFirewallSettings booleanisTrivialConfig booleanreachMeVia object
reachMeViaSelected booleanfwTrivialConfig object
firewallTrivialDetailsCS object
networkType integerconnectionType integerproxyEntity object
clientName stringclientId integerfirewallTrivialDetailsMA object
networkType integerconnectionType integerproxyEntity object
clientName stringclientId integerfirewallOptions object
isRoamingClient booleanextendedProperties stringtunnelconnectionPort integerforeceSSL booleantunnelInitSeconds integerlockdown booleanbindOpenPortsOnly booleanisDMZ booleankeepAliveSeconds integertppm object[]
deDuplicationProperties object
performClientSideDeduplication booleanenableHighLatencyOptimization booleancacheBufferSize integermaxCacheDb integerclientSideDeduplication integerenableVariableContentAlignment booleanenableClientSideDiskCache booleanspWebServerProperties object
enableOnlineSearch booleanspWebServerUserPassword object
activityControl object
EnableDataRecovery booleanEnableDataManagement booleanEnableOnlineContentIndex booleanadvancedClientProperties object
slaCopyFallenBehindDays integerrpoMinutes integermailServerRole integerrtoMinutes integerslaCopyRedundancy integerexcludeFromSLA booleandm2CacheDir object
path stringuserAccount object
userName stringrightManagementServiceProperties object
SMTPAddressOfTheRMSSuperUser stringdecryptRMSDocumentDuringContentIndexing booleansmtpAddressOfRMSSuperUser stringrmsCredentials object
password stringuserName stringclientActivityControl object
activityControlOptions object[]
activityType integerenableAfterADelay booleanenableActivityType booleanjobThrottleSettings object
isJobThrottleEnabledAtCS integerisJobThrottleEnabled integerdataThreshold integerexcludeImmidiateJobs integerlogThreshold integerwebSearchServer object
hostName stringclientId integeremailWebAppProperties object
enableEmailWebApp booleanexchangeAdminSmtpAddress stringexchangeAdministratorAccount object
userName stringclient object
displayName stringinstallDirectory stringClockSkewInSeconds integertimezoneSetByUser booleanclientDescription stringevmgrcPort integercvdPort integerjobResulsDir object
path stringuserAccount object
userName stringorigCommCell object
commCellId integerclientEntity object
hostName stringclientId integerclientName stringcommCellName stringclientGUID stringversionInfo object
UpdateStatus integerversion stringGalaxyRelease object
ReleaseString stringPatchStatus object[]
BaselineUpdates stringBaselineStatus integerpackageInfo object
packageId integerpackageName stringTimeZone object
TimeZoneID integerTimeZoneName stringosInfo object
Type stringSubType stringosId integerOsDisplayInfo object
ProcessorType stringOSName stringclientGroups object[]
clientGroupId integerclientGroupName stringAdvancedFeatures object[]
LicenseName stringLicenseId integerActivePhysicalNode object
hostName stringclientId integerclientName 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"
}
}
]
}
Loading...