AppCmdExecConfigParam Data Type

Properties
name data type constraints description
name string  
defaultValue string  
userFriendlyHint string  
showInUi boolean required
obligatory boolean required
envVariables array of EnvVariable  
guid string  
appCmdExecConfig AppCmdExecConfig  
ver number  
auditEntityName string  
nameAndGuid NameAndGuid  
nameGuidAndType NameGuidAndType  

Example

{
  "name" : "...",
  "defaultValue" : "...",
  "userFriendlyHint" : "...",
  "showInUi" : true,
  "obligatory" : true,
  "envVariables" : [ {
    "hiddenInUI" : true,
    "application" : {
      "guid" : "...",
      "ver" : 12345,
      "nodeConfig" : { },
      "appBackupPolicy" : { },
      "appCmdExecConfig" : { },
      "envVariables" : [ { }, { } ],
      "auditEntityName" : "...",
      "backupPolicy" : { },
      "peProviderForSystemNotification" : { },
      "nameAndGuid" : { },
      "name" : "...",
      "sshHost" : "...",
      "sshPort" : 12345,
      "lastSuccessfulFullBackupSizeForFETB" : 12345,
      "type" : "CLOUD",
      "lastSuccessfulFullBackup" : { },
      "lastRestoreJob" : { },
      "lastSuccessfulIncBackup" : { },
      "lastStoredSnapshotAssignments" : [ { }, { } ],
      "backups" : [ { }, { } ],
      "warningsPresent" : true,
      "buildInType" : "REAR_BACKUP",
      "credential" : { },
      "averageProgress" : 12345.0,
      "lastChainMarkedForDeletion" : true,
      "specialOperation" : "DISCARD_METADATA_DATABASES",
      "lastSuccessfulBackup" : { },
      "nameGuidAndType" : { },
      "present" : true,
      "snapshotMgmtPolicy" : { },
      "lastStoredSnapshot" : { },
      "lastStoredSnapshots" : [ { }, { } ],
      "typeDeletable" : true,
      "bounded" : true,
      "backupDestinationsByBackups" : [ { }, { } ],
      "storageProviderIfPresent" : { },
      "cloud" : true
    },
    "appCmdExecConfigParam" : {
      "name" : "...",
      "defaultValue" : "...",
      "userFriendlyHint" : "...",
      "showInUi" : true,
      "obligatory" : true,
      "envVariables" : [ { }, { } ],
      "guid" : "...",
      "appCmdExecConfig" : { },
      "ver" : 12345,
      "auditEntityName" : "...",
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    },
    "value" : "...",
    "name" : "...",
    "guid" : "...",
    "ver" : 12345,
    "auditEntityName" : "...",
    "nameAndGuid" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "nameGuidAndType" : {
      "type" : { },
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }
  }, {
    "hiddenInUI" : true,
    "application" : {
      "guid" : "...",
      "ver" : 12345,
      "nodeConfig" : { },
      "appBackupPolicy" : { },
      "appCmdExecConfig" : { },
      "envVariables" : [ { }, { } ],
      "auditEntityName" : "...",
      "backupPolicy" : { },
      "peProviderForSystemNotification" : { },
      "nameAndGuid" : { },
      "name" : "...",
      "sshHost" : "...",
      "sshPort" : 12345,
      "lastSuccessfulFullBackupSizeForFETB" : 12345,
      "type" : "STORAGE",
      "lastSuccessfulFullBackup" : { },
      "lastRestoreJob" : { },
      "lastSuccessfulIncBackup" : { },
      "lastStoredSnapshotAssignments" : [ { }, { } ],
      "backups" : [ { }, { } ],
      "warningsPresent" : true,
      "buildInType" : "OVIRT_RHV_DB_BACKUP",
      "credential" : { },
      "averageProgress" : 12345.0,
      "lastChainMarkedForDeletion" : true,
      "specialOperation" : "DISCARD_METADATA_DATABASES",
      "lastSuccessfulBackup" : { },
      "nameGuidAndType" : { },
      "present" : true,
      "snapshotMgmtPolicy" : { },
      "lastStoredSnapshot" : { },
      "lastStoredSnapshots" : [ { }, { } ],
      "typeDeletable" : true,
      "bounded" : true,
      "backupDestinationsByBackups" : [ { }, { } ],
      "storageProviderIfPresent" : { },
      "cloud" : true
    },
    "appCmdExecConfigParam" : {
      "name" : "...",
      "defaultValue" : "...",
      "userFriendlyHint" : "...",
      "showInUi" : true,
      "obligatory" : true,
      "envVariables" : [ { }, { } ],
      "guid" : "...",
      "appCmdExecConfig" : { },
      "ver" : 12345,
      "auditEntityName" : "...",
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    },
    "value" : "...",
    "name" : "...",
    "guid" : "...",
    "ver" : 12345,
    "auditEntityName" : "...",
    "nameAndGuid" : {
      "guid" : "...",
      "name" : "..."
    },
    "nameGuidAndType" : {
      "type" : { },
      "guid" : "...",
      "name" : "..."
    }
  } ],
  "guid" : "...",
  "appCmdExecConfig" : {
    "guid" : "...",
    "ver" : 12345,
    "name" : "...",
    "cmdArg" : [ "...", "..." ],
    "applications" : [ {
      "guid" : "...",
      "ver" : 12345,
      "nodeConfig" : { },
      "appBackupPolicy" : { },
      "appCmdExecConfig" : { },
      "envVariables" : [ { }, { } ],
      "auditEntityName" : "...",
      "backupPolicy" : { },
      "peProviderForSystemNotification" : { },
      "nameAndGuid" : { },
      "name" : "...",
      "sshHost" : "...",
      "sshPort" : 12345,
      "lastSuccessfulFullBackupSizeForFETB" : 12345,
      "type" : "CLOUD_USER",
      "lastSuccessfulFullBackup" : { },
      "lastRestoreJob" : { },
      "lastSuccessfulIncBackup" : { },
      "lastStoredSnapshotAssignments" : [ { }, { } ],
      "backups" : [ { }, { } ],
      "warningsPresent" : true,
      "buildInType" : "REAR_BACKUP",
      "credential" : { },
      "averageProgress" : 12345.0,
      "lastChainMarkedForDeletion" : true,
      "specialOperation" : "DISCARD_METADATA_DATABASES",
      "lastSuccessfulBackup" : { },
      "nameGuidAndType" : { },
      "present" : true,
      "snapshotMgmtPolicy" : { },
      "lastStoredSnapshot" : { },
      "lastStoredSnapshots" : [ { }, { } ],
      "typeDeletable" : true,
      "bounded" : true,
      "backupDestinationsByBackups" : [ { }, { } ],
      "storageProviderIfPresent" : { },
      "cloud" : true
    }, {
      "guid" : "...",
      "ver" : 12345,
      "nodeConfig" : { },
      "appBackupPolicy" : { },
      "appCmdExecConfig" : { },
      "envVariables" : [ { }, { } ],
      "auditEntityName" : "...",
      "backupPolicy" : { },
      "peProviderForSystemNotification" : { },
      "nameAndGuid" : { },
      "name" : "...",
      "sshHost" : "...",
      "sshPort" : 12345,
      "lastSuccessfulFullBackupSizeForFETB" : 12345,
      "type" : "VM",
      "lastSuccessfulFullBackup" : { },
      "lastRestoreJob" : { },
      "lastSuccessfulIncBackup" : { },
      "lastStoredSnapshotAssignments" : [ { }, { } ],
      "backups" : [ { }, { } ],
      "warningsPresent" : true,
      "buildInType" : "DB2_BACKUP",
      "credential" : { },
      "averageProgress" : 12345.0,
      "lastChainMarkedForDeletion" : true,
      "specialOperation" : "DISCARD_METADATA_DATABASES",
      "lastSuccessfulBackup" : { },
      "nameGuidAndType" : { },
      "present" : true,
      "snapshotMgmtPolicy" : { },
      "lastStoredSnapshot" : { },
      "lastStoredSnapshots" : [ { }, { } ],
      "typeDeletable" : true,
      "bounded" : true,
      "backupDestinationsByBackups" : [ { }, { } ],
      "storageProviderIfPresent" : { },
      "cloud" : true
    } ],
    "appCmdExecConfigParams" : [ {
      "name" : "...",
      "defaultValue" : "...",
      "userFriendlyHint" : "...",
      "showInUi" : true,
      "obligatory" : true,
      "envVariables" : [ { }, { } ],
      "guid" : "...",
      "appCmdExecConfig" : { },
      "ver" : 12345,
      "auditEntityName" : "...",
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    }, {
      "name" : "...",
      "defaultValue" : "...",
      "userFriendlyHint" : "...",
      "showInUi" : true,
      "obligatory" : true,
      "envVariables" : [ { }, { } ],
      "guid" : "...",
      "appCmdExecConfig" : { },
      "ver" : 12345,
      "auditEntityName" : "...",
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    } ],
    "cmdExecMethod" : "NODE",
    "exportData" : true,
    "removeFilesAfterExport" : true,
    "sourceType" : "FILE",
    "sourcePath" : "...",
    "buildInType" : "DB2_BACKUP",
    "timeout" : 12345,
    "userModifiable" : true,
    "nameAndGuid" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "ignoredExitCodes" : "...",
    "stdErrorHandling" : "DONT_IGNORE",
    "auditEntityName" : "...",
    "nameGuidAndType" : {
      "type" : { },
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "useNetcat" : true
  },
  "ver" : 12345,
  "auditEntityName" : "...",
  "nameAndGuid" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "nameGuidAndType" : {
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    },
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
}