Fetch CSLiveSync Config
This API retrieves all the information necessary with respect to the Commserve Failover and CS LiveSync.
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
csFailoverConfigInfo object
configStatus integerisAutomaticFailoverEnabled booleanenableTestFailoverGUI booleanisDRCSConfigured booleanisDRInstanceConfigurationPending booleanisAutoScaleEnabled booleanisFailoverPackageConfigured booleanisActiveInstanceConfigurationPending booleantlSchedule object
subtaskId integertaskName stringsubtaskName stringtaskId integerbackupSchedulePolicyInfo object
taskName stringtaskId integerbackupStoragePolicy object
storagePolicyName stringstoragePolicyId integerproxyFireWallTopologyInfo object
extendedProperties stringtopologyType integerdescription stringfirewallGroups object[]
fwGroupType integerisMnemonic booleanclientGroup object
_type_ integerclientGroupId integeroptions object
useWildcardProxy booleanconfigureAutomatically booleankeepAliveSeconds integertunnelConnectionPort integertopologyEntity object
_type_ integertopologyName stringtopologyId integersourceFirewallConfiguration object
configureFirewallSettings booleanisTrivialConfig booleanreachMeVia object
reachMeViaSelected booleanproxyEntities object[]
displayName stringclientId integerclientName stringclientGroupName stringclientGroupId integerfwTrivialConfig object
firewallTrivialDetailsCS object
networkType integerconnectionType integerproxyEntity object
displayName stringclientId integerclientName stringfirewallTrivialDetailsMA object
networkType integerconnectionType integerproxyEntity object
displayName stringclientId integerclientName stringfirewallOptions object
isRoamingClient booleanextendedProperties stringtunnelconnectionPort integerforeceSSL booleantunnelInitSeconds integerlockdown booleanbindOpenPortsOnly booleanisDMZ booleankeepAliveSeconds integertestFireWallTopologyInfo object
useWildcardProxy booleanextendedProperties stringtopologyType integerdescription stringfirewallGroups object[]
fwGroupType integerisMnemonic booleanclientGroup object
_type_ integerclientGroupId integeroptions object
useWildcardProxy booleanconfigureAutomatically booleankeepAliveSeconds integertunnelConnectionPort integertopologyEntity object
_type_ integertopologyName stringtopologyId integerplan object
planName stringplanId integeralertEntity object
alertName stringalertId integermiscSettings object
criticalFailOverStrikeCount integermonitoringInterval integerfloatingCommserveHostName booleanfailOverType integerdrDumpSettings object
backupMetadataFolder stringnetworkUserAccount object
testFailoverClientGroup object
clientGroupId integerclientGroupName stringMonitoringClients object
clientGroupId integerclientGroupName stringcsFailoverDatabases object
selectedDatabases string[]supportedDatabases string[]testFailoverProxyGroup object
clientGroupId integerclientGroupName stringfailoverNodeVersion object[]
clientId integerversionInfo object
version stringGalaxyRelease object
ReleaseString stringmonitoringNodes object
availableClients object[]
lastSyncTime integerstatus integernode object
clientId integerclientName stringfailoverNodes object[]
sourceJobResultsDir stringlastSyncTime integerdestinationJobResultsDir stringconfigStatus integerdestinationHyperVisorType integerdestinationClientPort integersourceClientPort integersourceHyperVisorType integerfirewallConfiguration object
configureFirewallSettings booleanisTrivialConfig booleanreachMeVia object
reachMeViaSelected booleanproxyEntities object[]
displayName stringclientId integerclientName stringclientGroupName stringclientGroupId integerfwTrivialConfig object
firewallTrivialDetailsCS object
networkType integerconnectionType integerproxyEntity object
displayName stringclientId integerclientName stringfirewallTrivialDetailsMA object
networkType integerconnectionType integerproxyEntity object
displayName stringclientId integerclientName stringfirewallOptions object
isRoamingClient booleanextendedProperties stringtunnelconnectionPort integerforeceSSL booleantunnelInitSeconds integerlockdown booleanbindOpenPortsOnly booleanisDMZ booleankeepAliveSeconds integerdestinationEntity object
hostName stringclientName stringinstanceName stringinstanceId integerclientId integerappName stringapplicationId integertaskEntity object
subtaskId integertaskId integersourceEntity object
hostName stringclientName stringinstanceName stringbackupsetId integerinstanceId integersubclientId integerclientId integerappName stringbackupsetName stringapplicationId integersubclientName string
{
"csFailoverConfigInfo": {
"configStatus": 0,
"isAutomaticFailoverEnabled": true,
"enableTestFailoverGUI": true,
"isDRCSConfigured": true,
"isDRInstanceConfigurationPending": true,
"isAutoScaleEnabled": true,
"isFailoverPackageConfigured": true,
"isActiveInstanceConfigurationPending": true,
"tlSchedule": {
"subtaskId": 0,
"taskName": "string",
"subtaskName": "string",
"taskId": 0
},
"backupSchedulePolicyInfo": {
"taskName": "string",
"taskId": 0
},
"backupStoragePolicy": {
"storagePolicyName": "string",
"storagePolicyId": 0
},
"proxyFireWallTopologyInfo": {
"extendedProperties": "string",
"topologyType": 0,
"description": "string",
"firewallGroups": [
{
"fwGroupType": 0,
"isMnemonic": true,
"clientGroup": {
"_type_": 0,
"clientGroupId": 0
},
"options": {
"useWildcardProxy": true,
"configureAutomatically": true,
"keepAliveSeconds": 0,
"tunnelConnectionPort": 0
}
}
],
"topologyEntity": {
"_type_": 0,
"topologyName": "string",
"topologyId": 0
}
},
"sourceFirewallConfiguration": {
"configureFirewallSettings": true,
"isTrivialConfig": true,
"reachMeVia": {
"reachMeViaSelected": true
},
"proxyEntities": [
{
"displayName": "string",
"clientId": 0,
"clientName": "string",
"clientGroupName": "string",
"clientGroupId": 0
}
],
"fwTrivialConfig": {
"firewallTrivialDetailsCS": {
"networkType": 0,
"connectionType": 0,
"proxyEntity": {
"displayName": "string",
"clientId": 0,
"clientName": "string"
}
},
"firewallTrivialDetailsMA": {
"networkType": 0,
"connectionType": 0,
"proxyEntity": {
"displayName": "string",
"clientId": 0,
"clientName": "string"
}
}
},
"firewallOptions": {
"isRoamingClient": true,
"extendedProperties": "string",
"tunnelconnectionPort": 0,
"foreceSSL": true,
"tunnelInitSeconds": 0,
"lockdown": true,
"bindOpenPortsOnly": true,
"isDMZ": true,
"keepAliveSeconds": 0
}
},
"testFireWallTopologyInfo": {
"useWildcardProxy": true,
"extendedProperties": "string",
"topologyType": 0,
"description": "string",
"firewallGroups": [
{
"fwGroupType": 0,
"isMnemonic": true,
"clientGroup": {
"_type_": 0,
"clientGroupId": 0
},
"options": {
"useWildcardProxy": true,
"configureAutomatically": true,
"keepAliveSeconds": 0,
"tunnelConnectionPort": 0
}
}
],
"topologyEntity": {
"_type_": 0,
"topologyName": "string",
"topologyId": 0
}
},
"plan": {
"planName": "string",
"planId": 0
},
"alertEntity": {
"alertName": "string",
"alertId": 0
},
"miscSettings": {
"criticalFailOverStrikeCount": 0,
"monitoringInterval": 0,
"floatingCommserveHostName": true,
"failOverType": 0,
"drDumpSettings": {
"backupMetadataFolder": "string",
"networkUserAccount": {}
},
"testFailoverClientGroup": {
"clientGroupId": 0,
"clientGroupName": "string"
},
"MonitoringClients": {
"clientGroupId": 0,
"clientGroupName": "string"
},
"csFailoverDatabases": {
"selectedDatabases": [
"string"
],
"supportedDatabases": [
"string"
]
},
"testFailoverProxyGroup": {
"clientGroupId": 0,
"clientGroupName": "string"
}
},
"failoverNodeVersion": [
{
"clientId": 0,
"versionInfo": {
"version": "string",
"GalaxyRelease": {
"ReleaseString": "string"
}
}
}
],
"monitoringNodes": {
"availableClients": [
{
"lastSyncTime": 0,
"status": 0,
"node": {
"clientId": 0,
"clientName": "string"
}
}
]
},
"failoverNodes": [
{
"sourceJobResultsDir": "string",
"lastSyncTime": 0,
"destinationJobResultsDir": "string",
"configStatus": 0,
"destinationHyperVisorType": 0,
"destinationClientPort": 0,
"sourceClientPort": 0,
"sourceHyperVisorType": 0,
"firewallConfiguration": {
"configureFirewallSettings": true,
"isTrivialConfig": true,
"reachMeVia": {
"reachMeViaSelected": true
},
"proxyEntities": [
{
"displayName": "string",
"clientId": 0,
"clientName": "string",
"clientGroupName": "string",
"clientGroupId": 0
}
],
"fwTrivialConfig": {
"firewallTrivialDetailsCS": {
"networkType": 0,
"connectionType": 0,
"proxyEntity": {
"displayName": "string",
"clientId": 0,
"clientName": "string"
}
},
"firewallTrivialDetailsMA": {
"networkType": 0,
"connectionType": 0,
"proxyEntity": {
"displayName": "string",
"clientId": 0,
"clientName": "string"
}
}
},
"firewallOptions": {
"isRoamingClient": true,
"extendedProperties": "string",
"tunnelconnectionPort": 0,
"foreceSSL": true,
"tunnelInitSeconds": 0,
"lockdown": true,
"bindOpenPortsOnly": true,
"isDMZ": true,
"keepAliveSeconds": 0
}
},
"destinationEntity": {
"hostName": "string",
"clientName": "string",
"instanceName": "string",
"instanceId": 0,
"clientId": 0,
"appName": "string",
"applicationId": 0
},
"taskEntity": {
"subtaskId": 0,
"taskId": 0
},
"sourceEntity": {
"hostName": "string",
"clientName": "string",
"instanceName": "string",
"backupsetId": 0,
"instanceId": 0,
"subclientId": 0,
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 0,
"subclientName": "string"
}
}
]
}
}
{
"csFailoverConfigInfo": {
"configStatus": 1,
"isAutomaticFailoverEnabled": true,
"enableTestFailoverGUI": false,
"isDRCSConfigured": true,
"isDRInstanceConfigurationPending": false,
"isAutoScaleEnabled": false,
"isFailoverPackageConfigured": true,
"isActiveInstanceConfigurationPending": false,
"tlSchedule": {
"subtaskId": 36,
"taskName": "System Created for Failover",
"subtaskName": "Failover Transaction Log schedule",
"taskId": 35
},
"backupSchedulePolicyInfo": {
"taskName": "System Created for Failover",
"taskId": 35
},
"backupStoragePolicy": {
"storagePolicyName": "LiveSync",
"storagePolicyId": 17
},
"proxyFireWallTopologyInfo": {
"extendedProperties": "<App_TopologyExtendedProperties displayType=\"0\"/>",
"topologyType": 2,
"description": "Network topology created by default for failover clients",
"firewallGroups": [
{
"fwGroupType": 2,
"isMnemonic": false,
"clientGroup": {
"_type_": 28,
"clientGroupId": 9
},
"options": {
"useWildcardProxy": false,
"configureAutomatically": true,
"keepAliveSeconds": 180,
"tunnelConnectionPort": 8403
}
},
{
"fwGroupType": 1,
"isMnemonic": false,
"clientGroup": {
"_type_": 28,
"clientGroupId": 10
},
"options": {
"useWildcardProxy": false,
"configureAutomatically": true,
"keepAliveSeconds": 180,
"tunnelConnectionPort": 8403
}
}
],
"topologyEntity": {
"_type_": 156,
"topologyName": "Network Topology created for failover clients",
"topologyId": 1
}
},
"sourceFirewallConfiguration": {
"configureFirewallSettings": true,
"isTrivialConfig": false,
"reachMeVia": {
"reachMeViaSelected": false
},
"proxyEntities": [
{
"displayName": "tcwin_2",
"clientId": 3,
"clientName": "tcwin_2"
},
{
"displayName": "tcwin1_2",
"clientId": 5,
"clientName": "tcwin1_2"
},
{
"clientGroupName": "Proxy Clients for test failover",
"clientGroupId": 16
},
{
"clientGroupName": "Proxy Clients for test failover (2)",
"clientGroupId": 21
}
],
"fwTrivialConfig": {
"firewallTrivialDetailsCS": {
"networkType": 1,
"connectionType": 1,
"proxyEntity": {
"displayName": "NO CLIENT",
"clientId": 1,
"clientName": "NO CLIENT"
}
},
"firewallTrivialDetailsMA": {
"networkType": 1,
"connectionType": 1,
"proxyEntity": {
"displayName": "NO CLIENT",
"clientId": 1,
"clientName": "NO CLIENT"
}
}
},
"firewallOptions": {
"isRoamingClient": false,
"extendedProperties": "<App_FirewallExtendedProperties configureAutomatically=\"1\" defaultOutgoingProtocol=\"2\"/>",
"tunnelconnectionPort": 8403,
"foreceSSL": false,
"tunnelInitSeconds": 30,
"lockdown": false,
"bindOpenPortsOnly": false,
"isDMZ": true,
"keepAliveSeconds": 180
}
},
"testFireWallTopologyInfo": {
"useWildcardProxy": false,
"extendedProperties": "<App_TopologyExtendedProperties displayType=\"0\"/>",
"topologyType": 1,
"description": "Test network topology created by default for Commserv Failover",
"firewallGroups": [
{
"fwGroupType": 3,
"isMnemonic": false,
"clientGroup": {
"_type_": 28,
"clientGroupId": 16
},
"options": {
"useWildcardProxy": false,
"configureAutomatically": true,
"keepAliveSeconds": 180,
"tunnelConnectionPort": 8403
}
},
{
"fwGroupType": 1,
"isMnemonic": false,
"clientGroup": {
"_type_": 28,
"clientGroupId": 17
},
"options": {
"useWildcardProxy": false,
"configureAutomatically": true,
"keepAliveSeconds": 180,
"tunnelConnectionPort": 8403
}
},
{
"fwGroupType": 2,
"isMnemonic": false,
"clientGroup": {
"_type_": 28,
"clientGroupId": 18
},
"options": {
"useWildcardProxy": false,
"configureAutomatically": true,
"keepAliveSeconds": 180,
"tunnelConnectionPort": 8403
}
}
],
"topologyEntity": {
"_type_": 156,
"topologyName": "Test network topology created for Commserv Failover",
"topologyId": 3
}
},
"plan": {
"planName": "",
"planId": 0
},
"alertEntity": {
"alertName": "",
"alertId": 0
},
"miscSettings": {
"criticalFailOverStrikeCount": 4,
"monitoringInterval": 5,
"floatingCommserveHostName": false,
"failOverType": 0,
"drDumpSettings": {
"backupMetadataFolder": "C:\\\\DR",
"networkUserAccount": {}
},
"testFailoverClientGroup": {
"clientGroupId": 19,
"clientGroupName": "System Created client group for test failover (2)"
},
"MonitoringClients": {
"clientGroupId": 32,
"clientGroupName": "Monitoring Clients"
},
"csFailoverDatabases": {
"selectedDatabases": [
"AppStudioDB",
"CommServ",
"CVCloud",
"DM2",
"UsageHistoryDB",
"WFEngine"
],
"supportedDatabases": [
"AppStudioDB",
"CacheDB",
"CommServ",
"CVCloud",
"DM2",
"HistoryDB",
"ResourceMgrDB",
"UsageHistoryDB",
"WFEngine"
]
},
"testFailoverProxyGroup": {
"clientGroupId": 20,
"clientGroupName": "System Created proxy group for test failover (2)"
}
},
"failoverNodeVersion": [
{
"clientId": 2,
"versionInfo": {
"version": "ServicePack:32.1",
"GalaxyRelease": {
"ReleaseString": "11"
}
}
},
{
"clientId": 3,
"versionInfo": {
"version": "ServicePack:32.1,Additional Updates:,PreRelease-6811-BIN",
"GalaxyRelease": {
"ReleaseString": "11"
}
}
},
{
"clientId": 5,
"versionInfo": {
"version": "ServicePack:32.1",
"GalaxyRelease": {
"ReleaseString": "11"
}
}
}
],
"monitoringNodes": {
"availableClients": [
{
"lastSyncTime": 0,
"status": 0,
"node": {
"clientId": 7,
"clientName": "tcwin1_3"
}
},
{
"lastSyncTime": 0,
"status": 0,
"node": {
"clientId": 9,
"clientName": "tcma"
}
},
{
"lastSyncTime": 0,
"status": 0,
"node": {
"clientId": 10,
"clientName": "controller"
}
}
]
},
"failoverNodes": [
{
"sourceJobResultsDir": "C:\\\\Commvault2\\\\iDataAgent\\\\JobResults",
"lastSyncTime": 0,
"destinationJobResultsDir": "E:\\\\Commvault\\\\iDataAgent\\\\JobResults",
"configStatus": 0,
"destinationHyperVisorType": 2,
"destinationClientPort": 8405,
"sourceClientPort": 8405,
"sourceHyperVisorType": 2,
"firewallConfiguration": {
"configureFirewallSettings": true,
"isTrivialConfig": false,
"reachMeVia": {
"reachMeViaSelected": false
},
"proxyEntities": [
{
"displayName": "tcwin_2",
"clientId": 3,
"clientName": "tcwin_2"
},
{
"displayName": "tcwin1_2",
"clientId": 5,
"clientName": "tcwin1_2"
},
{
"clientGroupName": "Proxy Clients for test failover",
"clientGroupId": 16
},
{
"clientGroupName": "Proxy Clients for test failover (2)",
"clientGroupId": 21
}
],
"fwTrivialConfig": {
"firewallTrivialDetailsCS": {
"networkType": 1,
"connectionType": 1,
"proxyEntity": {
"displayName": "NO CLIENT",
"clientId": 1,
"clientName": "NO CLIENT"
}
},
"firewallTrivialDetailsMA": {
"networkType": 1,
"connectionType": 1,
"proxyEntity": {
"displayName": "NO CLIENT",
"clientId": 1,
"clientName": "NO CLIENT"
}
}
},
"firewallOptions": {
"isRoamingClient": false,
"extendedProperties": "<App_FirewallExtendedProperties configureAutomatically=\"1\" defaultOutgoingProtocol=\"2\"/>",
"tunnelconnectionPort": 8403,
"foreceSSL": false,
"tunnelInitSeconds": 30,
"lockdown": false,
"bindOpenPortsOnly": false,
"isDMZ": true,
"keepAliveSeconds": 180
}
},
"destinationEntity": {
"hostName": "tcwin1.automation.commvault.com",
"clientName": "tcwin1_2",
"instanceName": "TCWIN1\\\\COMMVAULT",
"instanceId": 4,
"clientId": 5,
"appName": "SQL Server",
"applicationId": 81
},
"taskEntity": {
"subtaskId": 61,
"taskId": 59
},
"sourceEntity": {
"hostName": "TCWIN.automation.commvault.com",
"clientName": "tcwin_2",
"instanceName": "TCWIN\\\\COMMVAULT",
"backupsetId": 4,
"instanceId": 3,
"subclientId": 4,
"clientId": 3,
"appName": "SQL Server",
"backupsetName": "defaultBackupSet",
"applicationId": 81,
"subclientName": "CvFailoverLogShipping"
}
}
]
}
}
Loading...