Enumerations
This section describes the enumerations included in the CTERA Portal schema.
AccountStatus
|
active
|
The account is active, and the user can access the CTERA Portal.
|
|
inactive
|
The account is inactive, and the user cannot access the CTERA Portal.
|
ACLRuleType
|
localUser
|
A user defined in the portal.
|
|
adUser
|
An Active Directory user.
|
|
localGroup
|
A user group defined in the portal.
|
|
adGroup
|
An Active Directory group.
|
AdminUsernamePolicy
|
admin
|
The administrator's user name is admin.
|
|
email
|
The administrator's user name is the administrator's email address.
|
AdminPortalRole
|
ReadWriteAdmin
|
The administrator has read-write permissions throughout the CTERA Portal.
|
|
ReadOnlyAdmin
|
The administrator has read-only permissions throughout the CTERA Portal.
|
|
Support
|
The administrator has read/write access to devices, user accounts, folders, and folder groups, and read-only access to all other settings in the CTERA Portal.
|
BackupPassphraseProtectionPolicy
|
Optional
|
Passphrase protection for the backup folder is optional.
|
|
Required
|
Passphrase protection for the backup folder is mandatory.
|
|
Disabled
|
Passphrase protection for the backup folder is disabled.
|
BillingCycle
|
monthly
|
Invoices will be generated automatically once per month, counting from the date that the user joined the plan.
|
|
yearly
|
Invoices will be generated automatically once per year, counting from the date that the user joined the plan.
|
BillingMode
|
manual
|
The invoice must be processed manually.
|
|
automatic
|
The invoice will be processed automatically on its due date.
|
BooleanFunction
|
AND
|
All of the conditions must be met in order for a file to be included in the backup set.
|
|
OR
|
One or more of the conditions must be met in order for a file to be included in the backup set.
|
CalculatedAccountStatus
|
active
|
The user account is active.
|
|
inactive
|
The account is inactive, which means that the user cannot log in. A user account enters this state if the user self-registered and yet did not activate the account.
|
|
expired
|
The expiration time for the user account has passed. The user cannot log in and cannot perform backup or any other action.
|
CloudDriveLogging
|
None
|
No access to the folder on the cloud drive in which logging is saved.
|
|
Write
|
Write access to the folder on the cloud drive in which logging is saved.
|
|
ReadWrite
|
Read/Write access to the folder on the cloud drive in which logging is saved.
|
CloudFolderMode
|
online
|
The cloud folder is online.
|
|
readonly
|
The cloud folder is read-only.
|
CompressionMethod
|
HighCompression
|
Use high compression mode. This results in the best compression ratio.
|
|
HighSpeed
|
Use high-speed compression mode. This results in better performance.
|
Comment
|
FreeText
|
Text describing the user, such as the department or position the user has in the company. The text can be any string up to 255 characters.
|
CountryCode
|
AFGHANISTAN
|
AF
|
|
ALAND ISLANDS
|
AX
|
|
ALBANIA
|
AL
|
|
ALGERIA
|
DZ
|
|
AMERICAN SAMOA
|
AS
|
|
ANDORRA
|
AD
|
|
ANGOLA
|
AO
|
|
ANTIGUA AND BARBUDA
|
AG
|
|
ARGENTINA
|
AR
|
|
ARMENIA
|
AM
|
|
ARUBA
|
AW
|
|
AUSTRALIA
|
AU
|
|
AUSTRIA
|
AT
|
|
AZERBAIJAN
|
AZ
|
|
BAHAMAS
|
BS
|
|
BAHRAIN
|
BH
|
|
BANGLADESH
|
BD
|
|
BARBADOS
|
BB
|
|
BELARUS
|
BY
|
|
BELGIUM
|
BE
|
|
BELIZE
|
BZ
|
|
BENIN
|
BJ
|
|
BERMUDA
|
BM
|
|
BHUTAN
|
BT
|
|
BOLIVIA
|
BO
|
|
BOSNIA AND HERZEGOVINA
|
BA
|
|
BOTSWANA
|
BW
|
|
BOUVET ISLAND
|
BV
|
|
BRAZIL
|
BR
|
|
BRUNEI
|
BN
|
|
BULGARIA
|
BG
|
|
BURKINA FASO
|
BF
|
|
BURUNDI
|
BI
|
|
CAMBODIA
|
KH
|
|
CAMEROON
|
CM
|
|
CANADA
|
CA
|
|
CAPE VERDE
|
CV
|
|
CAYMAN ISLANDS
|
KY
|
|
CENTRAL AFRICAN REPUBLIC
|
CF
|
|
CHAD
|
TD
|
|
CHILE
|
CL
|
|
CHINA
|
CN
|
|
COLOMBIA
|
CO
|
|
COMOROS
|
KM
|
|
CONGO
|
CG
|
|
COSTA RICA
|
CR
|
|
COTE D'IVOIRE
|
CI
|
|
CROATIA
|
HR
|
|
CUBA
|
CU
|
|
CYPRUS
|
CY
|
|
CZECH REPUBLIC
|
CZ
|
|
DENMARK
|
DK
|
|
DJIBOUTI
|
DJ
|
|
DOMINICAN REPUBLIC
|
DO
|
|
ECUADOR
|
EC
|
|
EGYPT
|
EG
|
|
EL SALVADOR
|
SV
|
|
EQUATORIAL GUINEA
|
GQ
|
|
ERITREA
|
ER
|
|
ESTONIA
|
EE
|
|
ETHIOPIA
|
ET
|
|
FIJI
|
FJ
|
|
FINLAND
|
FI
|
|
FRANCE
|
FR
|
|
FRENCH GUIANA
|
GF
|
|
FRENCH POLYNESIA
|
PF
|
|
GABON
|
GA
|
|
GAMBIA
|
GM
|
|
GEORGIA
|
GE
|
|
GERMANY
|
DE
|
|
GHANA
|
GH
|
|
GIBRALTAR
|
GI
|
|
GREECE
|
GR
|
|
GREENLAND
|
GL
|
|
GRENADA
|
GD
|
|
GUADELOUPE
|
GP
|
|
GUAM
|
GU
|
|
GUATEMALA
|
GT
|
|
GUINEA
|
GN
|
|
GUINEA-BISSAU
|
GW
|
|
GUYANA
|
GY
|
|
HAITI
|
HT
|
|
HONDURAS
|
HN
|
|
HONG KONG
|
HK
|
|
HUNGARY
|
HU
|
|
ICELAND
|
IS
|
|
INDIA
|
IN
|
|
INDONESIA
|
ID
|
|
IRAN
|
IR
|
|
IRAQ
|
IQ
|
|
IRELAND
|
IE
|
|
ISLE OF MAN
|
IM
|
|
ISRAEL
|
IL
|
|
ITALY
|
IT
|
|
JAMAICA
|
JM
|
|
JAPAN
|
JP
|
|
JERSEY
|
JE
|
|
JORDAN
|
JO
|
|
KAZAKHSTAN
|
KZ
|
|
KENYA
|
KE
|
|
KIRIBATI
|
KI
|
|
KOREA, NORTH
|
KP
|
|
KOREA, SOUTH
|
KR
|
|
KUWAIT
|
KW
|
|
KYRGYZSTAN
|
KG
|
|
LAOS
|
LA
|
|
LATVIA
|
LV
|
|
LEBANON
|
LB
|
|
LESOTHO
|
LS
|
|
LIBERIA
|
LR
|
|
LIBYA
|
LY
|
|
LIECHTENSTEIN
|
LI
|
|
LITHUANIA
|
LT
|
|
LUXEMBOURG
|
LU
|
|
MACAO
|
MO
|
|
MACEDONIA
|
MK
|
|
MADAGASCAR
|
MG
|
|
MALAWI
|
MW
|
|
MALAYSIA
|
MY
|
|
MALDIVES
|
MV
|
|
MALI
|
ML
|
|
MALTA
|
MT
|
|
MARTINIQUE
|
MQ
|
|
MAURITANIA
|
MR
|
|
MAURITIUS
|
MU
|
|
MEXICO
|
MX
|
|
MICRONESIA
|
FM
|
|
MOLDOVA
|
MD
|
|
MONACO
|
MC
|
|
MONGOLIA
|
MN
|
|
MONTENEGRO
|
ME
|
|
MOROCCO
|
MA
|
|
MOZAMBIQUE
|
MZ
|
|
MYANMAR
|
MM
|
|
NAMIBIA
|
NA
|
|
NEPAL
|
NP
|
|
NETHERLANDS
|
NL
|
|
NEW CALEDONIA
|
NC
|
|
NEW ZEALAND
|
NZ
|
|
NICARAGUA
|
NI
|
|
NIGER
|
NE
|
|
NIGERIA
|
NG
|
|
NORWAY
|
NO
|
|
OMAN
|
OM
|
|
PAKISTAN
|
PK
|
|
PANAMA
|
PA
|
|
PAPUA NEW GUINEA
|
PG
|
|
PARAGUAY
|
PY
|
|
PERU
|
PE
|
|
PHILIPPINES
|
PH
|
|
POLAND
|
PL
|
|
PORTUGAL
|
PT
|
|
PUERTO RICO
|
PR
|
|
QATAR
|
QA
|
|
REUNION
|
RE
|
|
ROMANIA
|
RO
|
|
RUSSIA
|
RU
|
|
RWANDA
|
RW
|
|
SAINT LUCIA
|
LC
|
|
SAINT MARTIN
|
MF
|
|
SAINT VINCENT
|
VC
|
|
SAMOA
|
WS
|
|
SAN MARINO
|
SM
|
|
SAUDI ARABIA
|
SA
|
|
SENEGAL
|
SN
|
|
SERBIA
|
RS
|
|
SEYCHELLES
|
SC
|
|
SIERRA LEONE
|
SL
|
|
SINGAPORE
|
SG
|
|
SLOVAKIA
|
SK
|
|
SLOVENIA
|
SI
|
|
SOLOMON ISLANDS
|
SB
|
|
SOMALIA
|
SO
|
|
SOUTH AFRICA
|
ZA
|
|
SPAIN
|
ES
|
|
SRI LANKA
|
LK
|
|
SUDAN
|
SD
|
|
SURINAME
|
SR
|
|
SWAZILAND
|
SZ
|
|
SWEDEN
|
SE
|
|
SWITZERLAND
|
CH
|
|
SYRIAN ARAB REPUBLIC
|
SY
|
|
TAIWAN
|
TW
|
|
TAJIKISTAN
|
TJ
|
|
TANZANIA
|
TZ
|
|
THAILAND
|
TH
|
|
TIMOR-LESTE
|
TL
|
|
TOGO
|
TG
|
|
TRINIDAD AND TOBAGO
|
TT
|
|
TUNISIA
|
TN
|
|
TURKEY
|
TR
|
|
TURKMENISTAN
|
TM
|
|
UGANDA
|
UG
|
|
UKRAINE
|
UA
|
|
UNITED ARAB EMIRATES
|
AE
|
|
UNITED KINGDOM
|
GB
|
|
UNITED STATES
|
US
|
|
URUGUAY
|
UY
|
|
UZBEKISTAN
|
UZ
|
|
VANUATU
|
VU
|
|
VENEZUELA
|
VE
|
|
VIET NAM
|
VN
|
|
VIRGIN ISLANDS
|
VI
|
|
WESTERN SAHARA
|
EH
|
|
YEMEN
|
YE
|
|
ZAMBIA
|
ZM
|
|
ZIMBABWE
|
ZW
|
CountryCodeForRegion
|
AC
|
AD
|
AE
|
AF
|
AG
|
AI
|
AL
|
|
AM
|
AO
|
AR
|
AS
|
AT
|
AU
|
AW
|
|
AX
|
AZ
|
BA
|
BB
|
BD
|
BE
|
BF
|
|
BG
|
BH
|
BI
|
BJ
|
BL
|
BM
|
BN
|
|
BO
|
BQ
|
BR
|
BS
|
BT
|
BW
|
BY
|
|
BZ
|
CA
|
CC
|
CD
|
CF
|
CG
|
CH
|
|
CI
|
CK
|
CL
|
CM
|
CN
|
CO
|
CR
|
|
CU
|
CV
|
CW
|
CX
|
CY
|
CZ
|
DE
|
|
DJ
|
DK
|
DM
|
DO
|
DZ
|
EC
|
EE
|
|
EG
|
EH
|
ER
|
ES
|
ET
|
FI
|
FJ
|
|
FK
|
FM
|
FO
|
FR
|
GA
|
GB
|
GD
|
|
GE
|
GF
|
GG
|
GH
|
GI
|
GL
|
GM
|
|
GN
|
GP
|
GQ
|
GR
|
GT
|
GU
|
GW
|
|
GY
|
HK
|
HN
|
HR
|
HT
|
HU
|
ID
|
|
IE
|
IL
|
IM
|
IN
|
IO
|
IQ
|
IR
|
|
IS
|
IT
|
JE
|
JM
|
JO
|
JP
|
KE
|
|
KG
|
KH
|
KI
|
KM
|
KN
|
KP
|
KR
|
|
KW
|
KY
|
KZ
|
LA
|
LB
|
LC
|
LI
|
|
LK
|
LR
|
LS
|
LT
|
LU
|
LV
|
LY
|
|
MA
|
MC
|
MD
|
ME
|
MF
|
MG
|
MH
|
|
MK
|
ML
|
MM
|
MN
|
MO
|
MP
|
MQ
|
|
MR
|
MS
|
MT
|
MU
|
MV
|
MW
|
MX
|
|
MY
|
MZ
|
NA
|
NC
|
NE
|
NF
|
NG
|
|
NI
|
NL
|
NO
|
NP
|
NR
|
NU
|
NZ
|
|
OM
|
PA
|
PE
|
PF
|
PG
|
PH
|
PK
|
|
PL
|
PM
|
PR
|
PS
|
PT
|
PW
|
PY
|
|
QA
|
RE
|
RO
|
RS
|
RU
|
RW
|
SA
|
|
SB
|
SC
|
SD
|
SE
|
SG
|
SH
|
SI
|
|
SJ
|
SK
|
SL
|
SM
|
SN
|
SO
|
SR
|
|
SS
|
ST
|
SV
|
SX
|
SY
|
SZ
|
TA
|
|
TC
|
TD
|
TG
|
TH
|
TJ
|
TK
|
TL
|
|
TM
|
TN
|
TO
|
TR
|
TT
|
TV
|
TW
|
|
TZ
|
UA
|
UG
|
US
|
UY
|
UZ
|
VA
|
|
VC
|
VE
|
VG
|
VI
|
VN
|
VU
|
WF
|
|
WS
|
YE
|
YT
|
ZA
|
ZM
|
ZW
|
|
DayOfWeek
|
0
|
Sunday
|
|
1
|
Monday
|
|
2
|
Tuesday
|
|
3
|
Wednesday
|
|
4
|
Thursday
|
|
5
|
Friday
|
|
6
|
Saturday
|
DeviceType
|
C200
|
A C200 cloud storage gateway.
|
|
C400
|
A C400 cloud storage gateway.
|
|
C800
|
A C800 cloud storage gateway.
|
|
C800P
|
A C800+ cloud storage gateway.
|
|
HC400
|
An HC500 cloud storage gateway.
|
|
HC1200
|
An HC1200 cloud storage gateway.
|
|
Server Agent
|
An instance of CTERA Server Agent.
|
|
VBox
|
A VBox gateway.
|
|
VDI Agent
|
A Virtual Desktop Infrastructure Agent.
|
|
Workstation Agent
|
An instance of CTERA Workstation Agent.
|
|
Mobile
|
An instance of CTERA Mobile.
|
|
vGateway
|
An instance of a virtual cloud storage gateway.
|
DirectoryConnectorType
|
ActiveDirectory
|
The directory service is a Microsoft Active Directory service.
|
|
LDAP
|
The directory service is one of the following LDAP directory services:
 OpenDSOracle Unified DirectoryOracle Directory Server Enterprise EditionSun Java System Directory Server |
|
CloudPro
|
The directory service is a Cloud Pro service.
|
|
AppleOpenDirectory
|
The directory service is an Apple Open Directory service.
|
EnableDisable
|
enabled
|
The settings are enabled.
|
|
disabled
|
The settings are disabled.
|
EncryptionMode
|
Unencrypted
|
Do not use encryption.
|
|
RecoverableKeyEncryption
|
Use encryption key, but do not protect it with a user-provided secret passphrase.
|
|
SecretKeyEncryption
|
Use an encryption key protected by a user-provided passphrase. The key cannot be recovered if user loses the secret passphrase.
|
FileAccessMode
|
None
|
No access.
|
|
PreviewOnly
|
Preview-only access.
|
|
ReadOnly
|
Read-only access.
|
|
ReadWrite
|
Read-write access.
|
GenericRC
|
OK
|
A success code is returned.
|
|
PermanentError
|
An error code is returned.
|
|
TransientError
|
A transient error code is returned.
|
|
Warning
|
A warning code is returned.
|
|
NotCompleted
|
he procedure did not finish.
|
InvoiceStatus
|
Not Due Yet
|
Payment for the invoice is not yet due.
|
|
Due Today
|
Payment for the invoice is due today.
|
|
Overdue
|
Payment for the invoice is overdue.
|
|
Paid
|
The invoice has been paid.
|
|
Cancelled
|
The invoice has been canceled.
|
Language
|
en
|
English
|
|
fr
|
French
|
|
de
|
German
|
|
he
|
Hebrew
|
|
it
|
Italian
|
|
pl
|
Polish
|
|
sp
|
Spanish
|
|
pt
|
Portuguese
|
|
pt-br
|
Brazilian-Portuguese
|
|
zh-tw
|
Traditional Chinese
|
LogSeverity
|
emergency
|
System unusable.
|
|
alert
|
Immediate action needed.
|
|
critical
|
Critical condition.
|
|
error
|
Error condition.
|
|
warning
|
Warning condition, may indicate that an error will occur if immediate action is not taken.
|
|
notice
|
Normal but significant condition.
|
|
info
|
Informational message that require no action.
|
|
debug
|
Information useful to developers for debugging.
|
|
trace
|
Information useful to developers for enhanced debugging.
|
LogSourceType
|
all
|
A CTERA Cloud Storage Gateway and a CTERA server agent or CTERA workstation agent.
|
|
nas
|
A CTERA Cloud Storage Gateway.
|
|
pcAgent
|
A CTERA server agent or CTERA workstation agent.
|
LogTopic
|
allTopics
|
Any log category.
|
|
system
|
System logs.
|
|
backup
|
Backup logs.
|
|
sync
|
Local Backup logs.
|
|
access
|
Access logs.
|
|
audit
|
Audit logs.
|
|
files
|
Files.
|
|
agent
|
CTERA Agent logs.
|
|
antivirus
|
Antivirus logs.
|
|
accounting
|
Accounting logs.
|
|
cloudsync
|
Cloud backup logs.
|
OriginType
|
Device
|
A device: cloud storage gateway or agent.
|
|
Portal
|
A virtual portal.
|
Permission
|
None
|
No access.
|
|
PreviewOnly
|
Preview-only access.
|
|
ReadOnly
|
Read-only access.
|
|
ReadWrite
|
Read-write access.
|
PlanItemEnum
|
Storage Quota
|
Storage quota included in the plan or addon.
|
|
Server Agents
|
Server agents included in the plan or addon.
|
|
Workstation Agents
|
Workstation agents included in the plan or addon.
|
|
Appliances
|
Cloud storage gateways included in the plan or addon.
|
|
Cloud Drives
|
Cloud drives included in the plan or addon.
|
|
Cloud Drives Lite
|
Cloud Drive Connect agents included in the plan or addon.
|
|
vGateways4
|
Virtual Gateways licensed as EV4 included in the plan or addon.
|
|
vGateways8
|
Virtual Gateways licensed as EV8 included in the plan or addon.
|
|
vGateways32
|
Virtual Gateways licensed as EV32 included in the plan or addon.
|
|
vGateways64
|
Virtual Gateways licensed as EV64 included in the plan or addon.
|
PortalActivationStatus
|
Enabled
|
The portal is enabled.
|
|
Disabled
|
The portal is disabled.
|
PortalObjType
|
reseller
|
A reseller portal.
|
|
team
|
A team portal.
|
PortalRole
|
Disabled
|
The user account is disabled. The user cannot access the End User Portal.
|
|
EndUser
|
The user can access the End User Portal.
|
|
ReadWriteAdmin
|
The user can access the End User Portal, and can access the Administration tab of the End User Portal with read-write permissions.
|
|
ReadOnlyAdmin
|
The user can access the End User Portal, and can access the Administration tab of the End User Portal with read-only permissions.
|
|
Support
|
The user has read/write access to devices, user accounts, folders, and folder groups, and read-only access to all other settings in the CTERA Portal.
|
PortalServiceState
|
OK
|
The service status is OK.
|
|
Expired
|
The subscription to this service has expired.
|
|
Disabled
|
The service is disabled.
|
|
Lite
|
The service is a subset of the full license for users who do not need to collaborate on shared documents and folders with other users. Used by VDI users, for mobile users, and for 0-minute DR (disaster recovery).
|
|
Error
|
An error has occurred.
|
ProjectAccessMode
|
ReadOnly
|
Read only access to a project.
|
|
ReadWrite
|
Read write access to a project.
|
|
None
|
No access to a project.
|
ProtectionLevel
|
publicLink
|
Access is via a time limited link containing a secret access code to the folder or file. Public links can be freely forwarded by the recipient to any other person, and can also be posted on public websites and so on.
|
|
email
|
Two factor authentication is applied. The recipient receives a time limited authenticated link to the file or folder. On every access, a new 6 digit passcode challenge is sent to the recipient by email. The recipient must enter the passcode before accessing the file or folder. Thus, the invitation is not usable if the link is accidentally forwarded to another person, or posted on a public website.
|
|
textMessage
|
Two factor authentication is applied. The recipient receives a time limited authenticated link to the file or folder. On every access, a new 6 digit passcode challenge is sent to the recipient by text message. The recipient must enter the passcode before accessing the file or folder. Thus, the invitation is not usable if the link is accidentally forwarded to another person, or posted on a public website.
|
RemoteAccessType
|
Private_IP_redirect
|
Redirect remote access Web clients to the device's private IP address, if the client and device are on the same subnet.
|
|
Public_IP_redirect
|
Redirect remote access Web clients to the device's public IP address, if the client and device are on the same subnet.
|
|
No_redirect
|
Never redirect remote access Web clients. Relay all remote access communications through the portal.
|
ReportType
|
foldersStatisticsReport
|
A folders report.
|
|
folderGroupsStatisticsReport
|
A folder groups report.
|
|
storageLocationsStatisticsReport
|
A storage report.
|
|
portalsStatisticsReport
|
A portals report.
|
|
devicesStatisticsReport
|
A devices report.
|
|
plansStatisticsReport
|
A plans report.
|
|
addonsStatisticsReport
|
An addons report.
|
|
globalPlansStatisticsReport
|
A global plans report.
|
|
globalAddonsStatisticsReport
|
A global addons report.
|
ResellerPortalDeduplicationLevel
|
User
|
Deduplication between all backups or cloud drives associated with each user. No deduplication between different users' backups.
|
|
Folder
|
Deduplication within each folder only. No deduplication between folders.
|
ScheduleType
|
manual
|
Perform the task manually.
|
|
hourly
|
Perform the task once an hour.
|
|
daily
|
Perform the task once a day.
|
|
weekly
|
Perform the task once a week.
|
|
monthly
|
Perform the task once a month.
|
|
interval
|
Perform the task every specified number of hours and minutes.
|
|
window
|
Perform the task according to a configured time window.
|
SendFormat
|
plain
|
Send the email notification in plain text format.
|
|
html
|
Send the email notification in HTML format.
|
|
pdf
|
Send the email notification as a PDF.
|
SLAWarning
|
zeroQuota
|
A message that the user has no storage quota remaining on the account.
|
|
noCloudFolderService
|
A message that the cloud folder service is disabled for the user account.
|
|
noCloudBackupService
|
A message that the cloud backup service is disabled for the user account.
|
SsoType
|
None
|
Single Sign-on is not implemented.
|
|
Saml
|
Single Sign-on using a third-party SAML provider, such as Okta, OneLogin or ADFS, is implemented.
|
|
ClientCert
|
Use a client certificate or a Common Access Card (CAC) to implement single sign-on.
|
TeamPortalDeduplicationLevel
|
User
|
Deduplication between all backups or cloud drives associated with each user. No deduplication between different users' backups.
|
|
Portal
|
Deduplication between all folders in the portal.
|
|
Folder
|
Deduplication within each folder only. No deduplication between folders.
|