GlobalSettingsRequest Data Type

Properties
name data type constraints description
isInstanceIpVisibleInReporting boolean required
nodeStatusUpdateInterval number required
removedBackupRetention number required
removedSnapshotRetention number required
taskRetention number required
periodicInventorySyncInterval number required
periodicTapeManagerInventorySyncInterval number required
authSettings AuthSettingsRequest required
emailName string required, max size: 255, min size: 0
emailPort number required, max: 65535, min: 1
emailRequireAuth boolean required
emailSmtpServer string required, max size: 255, min size: 0
emailSslPort number max: 65535, min: 1
emailUserName string required, max size: 255, min size: 0
emailAddress string required, max size: 4096, min size: 0
emailSendingTime number required
backupRemovalTime number required
emailFailedBackupsNotification boolean required
emailGroupBy EmailGroupBy required
snapshotRemovalTime number required
statusReportingSettings StatusReportingSettingsRequest required
uiSettings UiSettingsRequest required
emailNotificationSettings array of EmailNotificationSettingsRequest required
sessionTimeout number required
unmountTimeLimit number required
unmountPeriodForMountedBackups number required

Example

{
  "isInstanceIpVisibleInReporting" : true,
  "nodeStatusUpdateInterval" : 12345,
  "removedBackupRetention" : 12345,
  "removedSnapshotRetention" : 12345,
  "taskRetention" : 12345,
  "periodicInventorySyncInterval" : 12345,
  "periodicTapeManagerInventorySyncInterval" : 12345,
  "authSettings" : {
    "authLdapEnabled" : true,
    "authLdapUrl" : "...",
    "authLdapBaseDn" : "...",
    "authLdapUserFilter" : "...",
    "authLdapUseTls" : true,
    "authLdapUseSsl" : true,
    "authLdapAnonymousAccessAllowed" : true,
    "authLdapBindDn" : "...",
    "authLdapBindPassword" : "...",
    "authLdapSubtreeSearchEnabled" : true,
    "authLdapGroups" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "keycloakEnabled" : true,
    "keycloakServerUrl" : "...",
    "keycloakRealm" : "...",
    "keycloakResource" : "...",
    "keycloakSecret" : "...",
    "keycloakServiceUser" : "...",
    "keycloakServicePassword" : "...",
    "keycloakCert" : "...",
    "keycloakGroups" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ]
  },
  "emailName" : "...",
  "emailPort" : 12345,
  "emailRequireAuth" : true,
  "emailSmtpServer" : "...",
  "emailSslPort" : 12345,
  "emailUserName" : "...",
  "emailAddress" : "...",
  "emailSendingTime" : 12345,
  "backupRemovalTime" : 12345,
  "emailFailedBackupsNotification" : true,
  "emailGroupBy" : "DATACENTER",
  "snapshotRemovalTime" : 12345,
  "statusReportingSettings" : {
    "statusReportingEnabled" : true,
    "statusReportingLogUploadEnabled" : true,
    "statusReportingBackupInfoEnabled" : true
  },
  "uiSettings" : {
    "uiDefaultPagingSize" : 12345,
    "uiConsoleMode" : "WORKFLOW"
  },
  "emailNotificationSettings" : [ {
    "guid" : "...",
    "type" : "TASK_STATE_CHANGED",
    "active" : true
  }, {
    "guid" : "...",
    "type" : "SNAPSHOT_REMOVAL",
    "active" : true
  } ],
  "sessionTimeout" : 12345,
  "unmountTimeLimit" : 12345,
  "unmountPeriodForMountedBackups" : 12345
}