Get Client
Select
SaaS
Customer Managed
This operation returns a list of clients.
Query Parameters
- hiddenClients boolean
Flag to return all the client including VMs and hidden clients
- includeIdaSummary boolean
- applicationId string
Return client with a particular application ID. Check the documentation for all the application IDs
- propertyLevel integer
Amount of details in the API response
- PseudoClientType string
Possible values: [
VSPseudo,CloudApps]Specify the type of pseudoclient to filter the API response. VSPseudo to return a list of virtualization clients. CloudApps to return a list of all cloud apps pseudo client
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
- Get Client with Hidden Clients
- Clients - Last Backup time
- Clients - Window File System
Schema
clientProperties object[]
clientProps object
iSCSIPort integerclusterType integerIsDeletedClient booleanclient object
evmgrcPort integercvdPort integerclientEntity object
hostName stringclientId integerclientName stringdisplayName string_type_ integerclientGUID string
{
"clientProperties": [
{
"clientProps": {
"iSCSIPort": 0,
"clusterType": 0,
"IsDeletedClient": true
},
"client": {
"evmgrcPort": 0,
"cvdPort": 0,
"clientEntity": {
"hostName": "string",
"clientId": 0,
"clientName": "string",
"displayName": "string",
"_type_": 0,
"clientGUID": "string"
}
}
}
]
}
{
"clientProperties": [
{
"clientProps": {
"iSCSIPort": 3260,
"clusterType": 0
},
"client": {
"evmgrcPort": 0,
"cvdPort": 8400,
"clientEntity": {
"hostName": "AryaSp10CS.test.com",
"clientId": 2,
"clientName": "aryasp10cs",
"displayName": "AryaSP10CS",
"_type_": 3,
"clientGUID": "349F4F26-349B-4B45-8256-D248E2FEF4D4"
}
}
},
{
"clientProps": {
"iSCSIPort": 3260,
"clusterType": 0,
"IsDeletedClient": true
},
"client": {
"evmgrcPort": 0,
"cvdPort": 0,
"clientEntity": {
"hostName": "vsa-vc6.test.com",
"clientId": 3,
"clientName": "vsa-vc6.test.com",
"displayName": "vsa-vc6.test.com",
"_type_": 3,
"clientGUID": "8C282421-2382-4B0A-B251-3C5ED4BA50D0"
}
}
}
]
}
{
"overview": {
"vmsCount": 2,
"unixServersCount": 0,
"nasFilersCount": 0,
"windowsServersCount": 9,
"fsCount": 9,
"databasesCount": 0,
"cloudAppsCount": 0
},
"clientProperties": [
{
"clientProps": {
"isVirtualServerDiscoveredClient": false,
"clientStatus": 0,
"isMA": true,
"isIndexingV2": true,
"isInfrastructure": false,
"specialClientFlags": 0,
"isCommCellPackageAbsent": false,
"clusterType": 0,
"isIndexingV2VSA": false,
"grcMigratedClient": false,
"IsDeletedClient": false,
"isUserCentricClient": false,
"IsVirtualClient": false,
"attributes": [
{
"name": "Is Unlicensed MA",
"value": "0"
}
]
},
"client": {
"osInfo": {
"Type": "Windows",
"SubType": "Server",
"osId": 210,
"OsDisplayInfo": {
"ProcessorType": "WinX64",
"OSName": "Windows Server 2012 R2 Datacenter"
}
},
"idaList": [
{
"summary": {
"size": 341,
"isSLAMet": false,
"lastBackupTime": 1579900486,
"defaultBackupset": {
"planEntity": {},
"backupSetEntity": {
"backupsetId": 3,
"backupsetName": "defaultBackupSet"
}
}
},
"idaEntity": {
"appName": "Windows File System",
"_type_": 4,
"applicationId": 33
}
},
{
"idaEntity": {
"appName": "Virtual Server",
"_type_": 4,
"applicationId": 106
}
},
{
"summary": {
"size": 0,
"isSLAMet": false,
"defaultBackupset": {
"planEntity": {},
"backupSetEntity": {
"backupsetId": 5,
"backupsetName": "defaultBackupSet"
}
}
},
"idaEntity": {
"appName": "Metrics Reporting Server",
"_type_": 4,
"applicationId": 121
}
}
],
"clientEntity": {
"hostName": "YashBackupCS.test.com",
"clientId": 2,
"clientName": "yashbackupcs",
"displayName": "yashbackupcs",
"clientGUID": "6E3DD0C1-4992-45BE-BBAF-0D3CE4B371C9"
},
"versionInfo": {
"UpdateStatus": 1,
"version": "11 SP16 HPK35+",
"GalaxyRelease": {
"ReleaseID": 16
}
}
}
},
{
"clientProps": {
"isVirtualServerDiscoveredClient": false,
"clientStatus": 0,
"isInfrastructure": false,
"specialClientFlags": 10,
"isCommCellPackageAbsent": true,
"clusterType": 0,
"isIndexingV2VSA": false,
"vendorType": 1,
"grcMigratedClient": false,
"isUserCentricClient": false
},
"client": {
"osInfo": {
"Type": "Any",
"SubType": "Any",
"osId": 0,
"OsDisplayInfo": {
"OSName": "Any"
}
},
"idaList": [
{
"summary": {
"size": 0,
"isSLAMet": false,
"lastBackupTime": 1539983015,
"defaultBackupset": {
"planEntity": {},
"backupSetEntity": {
"backupsetId": 16,
"backupsetName": "defaultBackupSet"
}
}
},
"idaEntity": {
"appName": "Virtual Server",
"_type_": 4,
"applicationId": 106
}
}
],
"clientEntity": {
"hostName": "vsa-vc65",
"clientId": 8,
"clientName": "vsa-vc65",
"displayName": "vsa-vc65",
"clientGUID": "A91C956E-6DDC-4985-8AD0-12E4D3D655C9"
},
"versionInfo": {
"UpdateStatus": 4,
"version": "11",
"GalaxyRelease": {
"ReleaseID": 16
}
}
}
},
{
"clientProps": {
"isVirtualServerDiscoveredClient": false,
"clientStatus": 1342177280,
"isInfrastructure": false,
"specialClientFlags": 2,
"isCommCellPackageAbsent": true,
"clusterType": 0,
"isIndexingV2VSA": false,
"grcMigratedClient": false,
"isUserCentricClient": false,
"plan": {
"_type_": 158,
"planName": "only_person",
"planId": 4
}
},
"client": {
"osInfo": {
"Type": "Windows",
"SubType": "Server",
"osId": 210,
"OsDisplayInfo": {
"OSName": "Windows"
}
},
"idaList": [
{
"summary": {
"size": 0,
"isSLAMet": false,
"defaultBackupset": {
"planEntity": {},
"backupSetEntity": {
"backupsetId": 25,
"backupsetName": "defaultBackupSet"
}
}
},
"idaEntity": {
"appName": "Windows File System",
"_type_": 4,
"applicationId": 33
}
},
{
"summary": {
"size": 0,
"isSLAMet": false,
"defaultBackupset": {
"planEntity": {},
"backupSetEntity": {
"backupsetId": 26,
"backupsetName": "User Mailbox"
}
}
},
"idaEntity": {
"appName": "Exchange Mailbox",
"_type_": 4,
"applicationId": 137
}
}
],
"clientEntity": {
"hostName": "ner_person",
"clientId": 14,
"clientName": "ner_person",
"displayName": "ner_person",
"clientGUID": "086E57C9-0547-4211-A33C-61DE7BB9A171"
},
"versionInfo": {
"UpdateStatus": 4,
"version": "11",
"GalaxyRelease": {
"ReleaseID": 16
}
}
}
},
{
"clientProps": {
"isVirtualServerDiscoveredClient": false,
"clientStatus": 134217728,
"isIndexingV2": true,
"isInfrastructure": false,
"specialClientFlags": 2,
"isCommCellPackageAbsent": true,
"clusterType": 0,
"isIndexingV2VSA": false,
"grcMigratedClient": false,
"isUserCentricClient": false
},
"client": {
"osInfo": {
"Type": "Any",
"SubType": "NAS",
"osId": 19,
"OsDisplayInfo": {
"OSName": "NAS Filer"
}
},
"idaList": [
{
"summary": {
"size": 0,
"isSLAMet": false,
"defaultBackupset": {
"planEntity": {},
"backupSetEntity": {
"backupsetId": 31,
"backupsetName": "defaultBackupSet"
}
}
},
"idaEntity": {
"appName": "Windows File System",
"_type_": 4,
"applicationId": 33
}
}
],
"clientEntity": {
"hostName": "ner_person_ner_online_14",
"clientId": 15,
"clientName": "ner_person_ner_online_14",
"displayName": "ner_person_ner_online_14",
"clientGUID": "C8E5AA79-AED8-4964-AAE1-5D0D31B6413A"
},
"versionInfo": {
"UpdateStatus": 4,
"version": "11",
"GalaxyRelease": {
"ReleaseID": 16
}
}
}
},
{
"clientProps": {
"isVirtualServerDiscoveredClient": false,
"clientStatus": 1342177280,
"isInfrastructure": false,
"specialClientFlags": 2,
"isCommCellPackageAbsent": true,
"clusterType": 0,
"isIndexingV2VSA": false,
"grcMigratedClient": false,
"isUserCentricClient": false,
"plan": {
"_type_": 158,
"planName": "SP13_Default",
"planId": 3
}
},
"client": {
"osInfo": {
"Type": "Windows",
"SubType": "Server",
"osId": 210,
"OsDisplayInfo": {
"OSName": "Windows"
}
},
"idaList": [
{
"summary": {
"size": 0,
"isSLAMet": false,
"defaultBackupset": {
"planEntity": {},
"backupSetEntity": {
"backupsetId": 33,
"backupsetName": "defaultBackupSet"
}
}
},
"idaEntity": {
"appName": "Windows File System",
"_type_": 4,
"applicationId": 33
}
},
{
"summary": {
"size": 0,
"isSLAMet": false,
"defaultBackupset": {
"planEntity": {},
"backupSetEntity": {
"backupsetId": 34,
"backupsetName": "User Mailbox"
}
}
},
"idaEntity": {
"appName": "Exchange Mailbox",
"_type_": 4,
"applicationId": 137
}
}
],
"clientEntity": {
"hostName": "SP13_default",
"clientId": 16,
"clientName": "SP13_default",
"displayName": "SP13_default",
"clientGUID": "4DF32B1C-32FD-4FBA-BAF2-7E5CA5B3B684"
},
"versionInfo": {
"UpdateStatus": 4,
"version": "11",
"GalaxyRelease": {
"ReleaseID": 16
}
}
}
},
{
"clientProps": {
"isVirtualServerDiscoveredClient": false,
"clientStatus": 134217728,
"isIndexingV2": true,
"isInfrastructure": false,
"specialClientFlags": 2,
"isCommCellPackageAbsent": true,
"clusterType": 0,
"isIndexingV2VSA": false,
"grcMigratedClient": false,
"isUserCentricClient": false
},
"client": {
"osInfo": {
"Type": "Any",
"SubType": "NAS",
"osId": 19,
"OsDisplayInfo": {
"OSName": "NAS Filer"
}
},
"idaList": [
{
"summary": {
"size": 0,
"isSLAMet": false,
"defaultBackupset": {
"planEntity": {},
"backupSetEntity": {
"backupsetId": 39,
"backupsetName": "defaultBackupSet"
}
}
},
"idaEntity": {
"appName": "Windows File System",
"_type_": 4,
"applicationId": 33
}
}
],
"clientEntity": {
"hostName": "SP13_default_test_data_small_17",
"clientId": 17,
"clientName": "SP13_default_test_data_small_17",
"displayName": "SP13_default_test_data_small_17",
"clientGUID": "883A35DD-5C73-405F-B065-71B0E33B239A"
},
"versionInfo": {
"UpdateStatus": 4,
"version": "11",
"GalaxyRelease": {
"ReleaseID": 16
}
}
}
},
{
"clientProps": {
"isVirtualServerDiscoveredClient": false,
"clientStatus": 134217728,
"isIndexingV2": true,
"isInfrastructure": false,
"specialClientFlags": 2,
"isCommCellPackageAbsent": true,
"clusterType": 0,
"isIndexingV2VSA": false,
"grcMigratedClient": false,
"isUserCentricClient": false
},
"client": {
"osInfo": {
"Type": "Any",
"SubType": "NAS",
"osId": 19,
"OsDisplayInfo": {
"OSName": "NAS Filer"
}
},
"idaList": [
{
"summary": {
"size": 0,
"isSLAMet": false,
"defaultBackupset": {
"planEntity": {},
"backupSetEntity": {
"backupsetId": 41,
"backupsetName": "defaultBackupSet"
}
}
},
"idaEntity": {
"appName": "Windows File System",
"_type_": 4,
"applicationId": 33
}
}
],
"clientEntity": {
"hostName": "SP13_default_test_data2_18",
"clientId": 18,
"clientName": "SP13_default_test_data2_18",
"displayName": "SP13_default_test_data2_18",
"clientGUID": "B351C311-E5E3-4478-A510-866DB08F9280"
},
"versionInfo": {
"UpdateStatus": 4,
"version": "11",
"GalaxyRelease": {
"ReleaseID": 16
}
}
}
},
{
"clientProps": {
"isVirtualServerDiscoveredClient": false,
"clientStatus": 134217728,
"isIndexingV2": true,
"isInfrastructure": false,
"specialClientFlags": 2,
"isCommCellPackageAbsent": true,
"clusterType": 0,
"isIndexingV2VSA": false,
"grcMigratedClient": false,
"isUserCentricClient": false
},
"client": {
"osInfo": {
"Type": "Any",
"SubType": "NAS",
"osId": 19,
"OsDisplayInfo": {
"OSName": "NAS Filer"
}
},
"idaList": [
{
"summary": {
"size": 0,
"isSLAMet": false,
"defaultBackupset": {
"planEntity": {},
"backupSetEntity": {
"backupsetId": 43,
"backupsetName": "defaultBackupSet"
}
}
},
"idaEntity": {
"appName": "Windows File System",
"_type_": 4,
"applicationId": 33
}
}
],
"clientEntity": {
"hostName": "SP13_default_test_data3_19",
"clientId": 19,
"clientName": "SP13_default_test_data3_19",
"displayName": "SP13_default_test_data3_19",
"clientGUID": "E26D6531-5150-414A-9A62-643F9F7B6BFE"
},
"versionInfo": {
"UpdateStatus": 4,
"version": "11",
"GalaxyRelease": {
"ReleaseID": 16
}
}
}
},
{
"clientProps": {
"isVirtualServerDiscoveredClient": false,
"clientStatus": 134217728,
"isIndexingV2": true,
"isInfrastructure": false,
"specialClientFlags": 2,
"isCommCellPackageAbsent": true,
"clusterType": 0,
"isIndexingV2VSA": false,
"grcMigratedClient": false,
"isUserCentricClient": false
},
"client": {
"osInfo": {
"Type": "Any",
"SubType": "NAS",
"osId": 19,
"OsDisplayInfo": {
"OSName": "NAS Filer"
}
},
"idaList": [
{
"summary": {
"size": 0,
"isSLAMet": false,
"defaultBackupset": {
"planEntity": {},
"backupSetEntity": {
"backupsetId": 45,
"backupsetName": "defaultBackupSet"
}
}
},
"idaEntity": {
"appName": "Windows File System",
"_type_": 4,
"applicationId": 33
}
}
],
"clientEntity": {
"hostName": "SP13_default_maverick_20",
"clientId": 20,
"clientName": "SP13_default_maverick_20",
"displayName": "SP13_default_maverick_20",
"clientGUID": "03DD7E3B-5323-41A6-B5A3-E6B6955747C1"
},
"versionInfo": {
"UpdateStatus": 4,
"version": "11",
"GalaxyRelease": {
"ReleaseID": 16
}
}
}
},
{
"clientProps": {
"isVirtualServerDiscoveredClient": false,
"clientStatus": 1342177280,
"isInfrastructure": false,
"specialClientFlags": 2,
"isCommCellPackageAbsent": true,
"clusterType": 0,
"isIndexingV2VSA": false,
"grcMigratedClient": false,
"isUserCentricClient": false,
"plan": {
"_type_": 158,
"planName": "SP13_Default",
"planId": 3
}
},
"client": {
"osInfo": {
"Type": "Windows",
"SubType": "Server",
"osId": 210,
"OsDisplayInfo": {
"OSName": "Windows"
}
},
"idaList": [
{
"summary": {
"size": 0,
"isSLAMet": false,
"defaultBackupset": {
"planEntity": {},
"backupSetEntity": {
"backupsetId": 47,
"backupsetName": "defaultBackupSet"
}
}
},
"idaEntity": {
"appName": "Windows File System",
"_type_": 4,
"applicationId": 33
}
},
{
"summary": {
"size": 0,
"isSLAMet": false,
"defaultBackupset": {
"planEntity": {},
"backupSetEntity": {
"backupsetId": 48,
"backupsetName": "User Mailbox"
}
}
},
"idaEntity": {
"appName": "Exchange Mailbox",
"_type_": 4,
"applicationId": 137
}
}
],
"clientEntity": {
"hostName": "cs_clients",
"clientId": 21,
"clientName": "cs_clients",
"displayName": "cs_clients",
"clientGUID": "01B9C17F-159C-4C24-A4E3-3B152DF559B9"
},
"versionInfo": {
"UpdateStatus": 4,
"version": "11",
"GalaxyRelease": {
"ReleaseID": 16
}
}
}
}
]
}
{
"clientProperties": [
{
"clientProps": {
"iSCSIPort": 3260,
"clusterType": 0
},
"client": {
"evmgrcPort": 0,
"cvdPort": 8400,
"clientEntity": {
"hostName": "",
"clientId": 2,
"clientName": "dm2perf4",
"displayName": "dm2perf4_DN",
"_type_": 3,
"clientGUID": "31B8C004-387A-4DC9-A156-ED798AFF7647",
"multiCommCellId": 0
}
}
},
{
"clientProps": {
"iSCSIPort": 3260,
"clusterType": 0
},
"client": {
"evmgrcPort": 0,
"cvdPort": 0,
"clientEntity": {
"hostName": "",
"clientId": 7,
"clientName": "11CS_online_P6_1581697222_7",
"displayName": "11CS_online_P6_1581697222",
"_type_": 3,
"providerId": 0,
"clientGUID": "C70A7ABF-19D3-4AA9-8913-8B5F6E13A48E",
"multiCommCellId": 0
}
}
},
{
"clientProps": {
"iSCSIPort": 3260,
"clusterType": 0
},
"client": {
"evmgrcPort": 0,
"cvdPort": 0,
"clientEntity": {
"hostName": "",
"clientId": 8,
"clientName": "11CS6_online_P6_1581698094_10",
"displayName": "11CS6_online_P6_1581698094",
"_type_": 3,
"providerId": 0,
"clientGUID": "495CD3B6-6C03-4F89-BF75-511933E055FE",
"multiCommCellId": 0
}
}
},
{
"clientProps": {
"iSCSIPort": 3260,
"clusterType": 0
},
"client": {
"evmgrcPort": 0,
"cvdPort": 0,
"clientEntity": {
"hostName": "",
"clientId": 9,
"clientName": "sp20_2_common_centos7_proj",
"displayName": "sp20_2_common_centos7_proj_DN",
"_type_": 3,
"providerId": 0,
"clientGUID": "AEDEF739-CAED-45D3-9607-78F525DCC76F",
"multiCommCellId": 0
}
}
},
{
"clientProps": {
"iSCSIPort": 3260,
"clusterType": 0
},
"client": {
"evmgrcPort": 0,
"cvdPort": 0,
"clientEntity": {
"hostName": "",
"clientId": 10,
"clientName": "11PD-CLUS1_online_P9_1581698224_13",
"displayName": "11PD-CLUS1_online_P9_1581698224",
"_type_": 3,
"providerId": 0,
"clientGUID": "8B2D6A28-7347-4104-9E01-3403261088D7",
"multiCommCellId": 0
}
}
},
{
"clientProps": {
"iSCSIPort": 3260,
"clusterType": 0
},
"client": {
"evmgrcPort": 0,
"cvdPort": 0,
"clientEntity": {
"hostName": "",
"clientId": 11,
"clientName": "11UPGRADE1_online_P9_1581699796_14",
"displayName": "11UPGRADE1_online_P9_1581699796",
"_type_": 3,
"providerId": 0,
"clientGUID": "73446A02-8D6C-460B-843B-2DE17FF5D5EF",
"multiCommCellId": 0
}
}
},
{
"clientProps": {
"iSCSIPort": 3260,
"clusterType": 0
},
"client": {
"evmgrcPort": 0,
"cvdPort": 0,
"clientEntity": {
"hostName": "",
"clientId": 14,
"clientName": "OCR_Proj",
"displayName": "OCR_Proj",
"_type_": 3,
"providerId": 0,
"clientGUID": "E008918C-0C9E-4D3A-BFDB-37BC5B1DDE6D",
"multiCommCellId": 0
}
}
},
{
"clientProps": {
"iSCSIPort": 3260,
"clusterType": 0
},
"client": {
"evmgrcPort": 0,
"cvdPort": 0,
"clientEntity": {
"hostName": "",
"clientId": 15,
"clientName": "named_entities_only_proj",
"displayName": "named_entities_only_proj",
"_type_": 3,
"providerId": 0,
"clientGUID": "1A0E081B-D60A-481A-A98C-FD649D3F1229",
"multiCommCellId": 0
}
}
},
{
"clientProps": {
"iSCSIPort": 3260,
"clusterType": 0
},
"client": {
"evmgrcPort": 0,
"cvdPort": 0,
"clientEntity": {
"hostName": "",
"clientId": 16,
"clientName": "less_than_1mb_files_only_proj",
"displayName": "less_than_1mb_files_only_proj",
"_type_": 3,
"providerId": 0,
"clientGUID": "0BDD8AEE-AD08-40B4-9DCD-5DC0A0C40ECA",
"multiCommCellId": 0
}
}
}
]
}
Loading...