comet_backup_ruby_sdk 2.7.0 → 2.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +6 -0
- data/Gemfile.lock +1 -1
- data/comet_backup_ruby_sdk.gemspec +1 -1
- data/lib/comet/definitions.rb +201 -181
- data/lib/comet/models/add_bucket_response_message.rb +1 -0
- data/lib/comet/models/admin_resource_response.rb +1 -0
- data/lib/comet/models/azure_destination_location.rb +1 -0
- data/lib/comet/models/b2destination_location.rb +5 -0
- data/lib/comet/models/backup_job_advanced_options.rb +6 -0
- data/lib/comet/models/backup_job_detail.rb +14 -0
- data/lib/comet/models/backup_job_progress.rb +1 -0
- data/lib/comet/models/backup_rule_config.rb +13 -0
- data/lib/comet/models/backup_rule_event_triggers.rb +3 -0
- data/lib/comet/models/browse_disk_drives_response.rb +1 -0
- data/lib/comet/models/browse_edbresponse.rb +1 -0
- data/lib/comet/models/browse_hvresponse.rb +1 -0
- data/lib/comet/models/browse_office_365list_virtual_accounts_response.rb +1 -0
- data/lib/comet/models/browse_office_365objects_response.rb +1 -0
- data/lib/comet/models/browse_sqlserver_response.rb +1 -0
- data/lib/comet/models/browse_vssresponse.rb +1 -0
- data/lib/comet/models/bucket_usage_info.rb +2 -0
- data/lib/comet/models/comet_apiresponse_message.rb +1 -0
- data/lib/comet/models/constellation_status_apiresponse.rb +1 -0
- data/lib/comet/models/create_group_policy_response.rb +1 -0
- data/lib/comet/models/destination_config.rb +13 -0
- data/lib/comet/models/destination_location.rb +4 -0
- data/lib/comet/models/device_config.rb +4 -0
- data/lib/comet/models/dispatcher_admin_sources_response.rb +1 -0
- data/lib/comet/models/dispatcher_stored_objects_response.rb +1 -0
- data/lib/comet/models/dispatcher_vault_snapshots_response.rb +1 -0
- data/lib/comet/models/dispatcher_windisk_snapshot_response.rb +1 -0
- data/lib/comet/models/email_options.rb +1 -0
- data/lib/comet/models/email_report_config.rb +3 -0
- data/lib/comet/models/email_report_generated_preview.rb +1 -0
- data/lib/comet/models/extra_file_exclusion.rb +4 -0
- data/lib/comet/models/ftpdestination_location.rb +1 -0
- data/lib/comet/models/get_group_policy_response.rb +1 -0
- data/lib/comet/models/get_profile_and_hash_response_message.rb +4 -0
- data/lib/comet/models/get_profile_hash_response_message.rb +1 -0
- data/lib/comet/models/group_policy.rb +4 -0
- data/lib/comet/models/install_token_response.rb +1 -0
- data/lib/comet/models/job_entry.rb +2 -0
- data/lib/comet/models/live_user_connection.rb +11 -0
- data/lib/comet/models/mongo_dbconnection.rb +2 -0
- data/lib/comet/models/office_365object_info.rb +1 -0
- data/lib/comet/models/request_storage_vault_response_message.rb +1 -0
- data/lib/comet/models/restore_job_advanced_options.rb +18 -0
- data/lib/comet/models/retention_policy.rb +1 -0
- data/lib/comet/models/retention_range.rb +1 -0
- data/lib/comet/models/s3destination_location.rb +1 -0
- data/lib/comet/models/search_snapshots_response.rb +1 -0
- data/lib/comet/models/server_config_options.rb +5 -0
- data/lib/comet/models/server_meta_branding_properties.rb +4 -0
- data/lib/comet/models/server_meta_version_info.rb +8 -0
- data/lib/comet/models/session_key_regenerated_response.rb +1 -0
- data/lib/comet/models/sftpdestination_location.rb +1 -0
- data/lib/comet/models/source_config.rb +51 -0
- data/lib/comet/models/sshconnection.rb +1 -0
- data/lib/comet/models/swift_destination_location.rb +7 -0
- data/lib/comet/models/test_response.rb +1 -0
- data/lib/comet/models/time_span.rb +2 -0
- data/lib/comet/models/totp_regenerated_response.rb +1 -0
- data/lib/comet/models/u2fregistration_challenge_response.rb +1 -0
- data/lib/comet/models/uninstall_config.rb +4 -0
- data/lib/comet/models/update_campaign_options.rb +3 -0
- data/lib/comet/models/update_campaign_properties.rb +3 -0
- data/lib/comet/models/update_campaign_status.rb +3 -0
- data/lib/comet/models/user_on_server.rb +2 -0
- data/lib/comet/models/user_profile_config.rb +36 -0
- data/lib/comet/models/vmdksnapshot_view_options.rb +4 -0
- data/lib/comet/models/web_authn_registration_challenge_response.rb +1 -0
- data/lib/comet/models/win_smbauth.rb +6 -0
- metadata +2 -2
@@ -18,24 +18,35 @@ module Comet
|
|
18
18
|
# @type [String] device_id
|
19
19
|
attr_accessor :device_id
|
20
20
|
|
21
|
+
# The Comet Backup software version that this live-connected device reports that it is running. It
|
22
|
+
# takes the format "MAJOR.MINOR.PATCH", such as "23.2.0". See the APPLICATION_VERSION constant for
|
23
|
+
# more information.
|
21
24
|
# @type [String] reported_version
|
22
25
|
attr_accessor :reported_version
|
23
26
|
|
27
|
+
# The operating system of the device. It is one of the PLATFORM_ constants; then a forwardslash (/);
|
28
|
+
# then the device's GOARCH.
|
24
29
|
# @type [String] reported_platform
|
25
30
|
attr_accessor :reported_platform
|
26
31
|
|
32
|
+
# The operating system of the device, in extended detail.
|
27
33
|
# @type [Comet::OSInfo] reported_platform_version
|
28
34
|
attr_accessor :reported_platform_version
|
29
35
|
|
36
|
+
# The reported timezone of the device, in IANA format.
|
30
37
|
# @type [String] device_time_zone
|
31
38
|
attr_accessor :device_time_zone
|
32
39
|
|
40
|
+
# The live-connected device's remote IP address, as seen from the Comet Server.
|
33
41
|
# @type [String] ipaddress
|
34
42
|
attr_accessor :ipaddress
|
35
43
|
|
44
|
+
# Unix timestamp, in seconds.
|
36
45
|
# @type [Number] connection_time
|
37
46
|
attr_accessor :connection_time
|
38
47
|
|
48
|
+
# The current state of the "Allow administrator to view my files" client-side option. If this option
|
49
|
+
# is refused, some live-connected actions will be refused by the device.
|
39
50
|
# @type [Boolean] allows_filenames
|
40
51
|
attr_accessor :allows_filenames
|
41
52
|
|
@@ -27,6 +27,8 @@ module Comet
|
|
27
27
|
# @type [String] authentication_db
|
28
28
|
attr_accessor :authentication_db
|
29
29
|
|
30
|
+
# Prior to Comet 22.12.3, must be a filesystem path to `mongo` (n.b. not `mongosh`). In Comet >=
|
31
|
+
# 22.12.3, not used.
|
30
32
|
# @type [String] mongo_shell_path
|
31
33
|
# @deprecated This member has been deprecated since Comet version 22.12.3
|
32
34
|
attr_accessor :mongo_shell_path
|
@@ -12,6 +12,7 @@ module Comet
|
|
12
12
|
# RequestStorageVaultResponseMessage is a typed class wrapper around the underlying Comet Server API data structure.
|
13
13
|
class RequestStorageVaultResponseMessage
|
14
14
|
|
15
|
+
# If the operation was successful, the status will be in the 200-299 range.
|
15
16
|
# @type [Number] status
|
16
17
|
attr_accessor :status
|
17
18
|
|
@@ -15,54 +15,72 @@ module Comet
|
|
15
15
|
# @type [Number] type
|
16
16
|
attr_accessor :type
|
17
17
|
|
18
|
+
# For RESTORETYPE_FILE
|
18
19
|
# @type [Boolean] overwrite_existing_files
|
19
20
|
attr_accessor :overwrite_existing_files
|
20
21
|
|
22
|
+
# For RESTORETYPE_FILE. If set, OverwriteExistingFiles must be true
|
21
23
|
# @type [Boolean] overwrite_if_newer
|
22
24
|
attr_accessor :overwrite_if_newer
|
23
25
|
|
26
|
+
# For RESTORETYPE_FILE. If set, DestPath must be blank
|
24
27
|
# @type [Boolean] dest_is_original_location
|
25
28
|
attr_accessor :dest_is_original_location
|
26
29
|
|
30
|
+
# For RESTORETYPE_FILE or RESTORETYPE_PROCESS_xxx
|
27
31
|
# @type [String] dest_path
|
28
32
|
attr_accessor :dest_path
|
29
33
|
|
34
|
+
# For RESTORETYPE_WINDISK only. Must have one entry for each selected restore path
|
30
35
|
# @type [Array<String>] exact_dest_paths
|
31
36
|
attr_accessor :exact_dest_paths
|
32
37
|
|
38
|
+
# For RESTORETYPE_FILE_ARCHIVE or RESTORETYPE_PROCESS_ARCHIVE. Default 0 is *.tar, for backward
|
39
|
+
# compatibility
|
33
40
|
# @type [Number] archive_format
|
34
41
|
attr_accessor :archive_format
|
35
42
|
|
43
|
+
# For RESTORETYPE_OFFICE365_CLOUD.
|
36
44
|
# @type [Comet::Office365Credential] office_365credential
|
37
45
|
attr_accessor :office_365credential
|
38
46
|
|
47
|
+
# For RESTORETYPE_MYSQL
|
39
48
|
# @type [String] username
|
40
49
|
attr_accessor :username
|
41
50
|
|
51
|
+
# For RESTORETYPE_MYSQL
|
42
52
|
# @type [String] password
|
43
53
|
attr_accessor :password
|
44
54
|
|
55
|
+
# For RESTORETYPE_MYSQL
|
45
56
|
# @type [String] host
|
46
57
|
attr_accessor :host
|
47
58
|
|
59
|
+
# For RESTORETYPE_MYSQL
|
48
60
|
# @type [String] port
|
49
61
|
attr_accessor :port
|
50
62
|
|
63
|
+
# For RESTORETYPE_MYSQL
|
51
64
|
# @type [Boolean] use_ssl
|
52
65
|
attr_accessor :use_ssl
|
53
66
|
|
67
|
+
# For RESTORETYPE_MYSQL i.e.: Self signed certs
|
54
68
|
# @type [Boolean] ssl_allow_invalid
|
55
69
|
attr_accessor :ssl_allow_invalid
|
56
70
|
|
71
|
+
# For RESTORETYPE_MYSQL
|
57
72
|
# @type [String] ssl_ca_file
|
58
73
|
attr_accessor :ssl_ca_file
|
59
74
|
|
75
|
+
# For RESTORETYPE_MYSQL
|
60
76
|
# @type [String] ssl_crt_file
|
61
77
|
attr_accessor :ssl_crt_file
|
62
78
|
|
79
|
+
# For RESTORETYPE_MYSQL
|
63
80
|
# @type [String] ssl_key_file
|
64
81
|
attr_accessor :ssl_key_file
|
65
82
|
|
83
|
+
# For RESTORETYPE_MSSQL.
|
66
84
|
# @type [Comet::MSSQLLoginArgs] ms_sql_connection
|
67
85
|
attr_accessor :ms_sql_connection
|
68
86
|
|
@@ -12,6 +12,7 @@ module Comet
|
|
12
12
|
# SearchSnapshotsResponse is a typed class wrapper around the underlying Comet Server API data structure.
|
13
13
|
class SearchSnapshotsResponse
|
14
14
|
|
15
|
+
# If the operation was successful, the status will be in the 200-299 range.
|
15
16
|
# @type [Number] status
|
16
17
|
attr_accessor :status
|
17
18
|
|
@@ -24,6 +24,11 @@ module Comet
|
|
24
24
|
# @type [Comet::ConstellationRoleOptions] constellation_role
|
25
25
|
attr_accessor :constellation_role
|
26
26
|
|
27
|
+
# This field is defined for compatibility with 17.x.x versions of Comet Server. Do not rely on this
|
28
|
+
# field. In Comet 23.2.x, if this field is defined, it is imported into the replacement
|
29
|
+
# 'ConstellationRole' field under the assumption that you are upgrading this Comet Server from a
|
30
|
+
# 17.x.x version. In Comet 23.3.x and later, this field is ignored and will not be respected during
|
31
|
+
# the import process.
|
27
32
|
# @type [Comet::ConstellationRoleOptions] constellation_role__legacy
|
28
33
|
attr_accessor :constellation_role__legacy
|
29
34
|
|
@@ -18,9 +18,13 @@ module Comet
|
|
18
18
|
# @type [String] product_name
|
19
19
|
attr_accessor :product_name
|
20
20
|
|
21
|
+
# If true, this Comet Server has an image configured for its main logo. You can access it from the
|
22
|
+
# /gen/logo.img endpoint. If false, this Comet Server has text configured for its main logo.
|
21
23
|
# @type [Boolean] has_image
|
22
24
|
attr_accessor :has_image
|
23
25
|
|
26
|
+
# A value that will change if the branding image (/gen/logo.img) changes. You can use this as a
|
27
|
+
# cache key.
|
24
28
|
# @type [String] image_etag
|
25
29
|
attr_accessor :image_etag
|
26
30
|
|
@@ -28,6 +28,7 @@ module Comet
|
|
28
28
|
attr_accessor :software_build_role
|
29
29
|
|
30
30
|
# @type [Boolean] constellation_role__legacy
|
31
|
+
# @deprecated This member has been deprecated since Comet version 18.2.0 "Overseer Role" was the old name for the Constellation Role. This field is a duplicate of ConstellationRole for backward compatibility with earlier API consumers.
|
31
32
|
attr_accessor :constellation_role__legacy
|
32
33
|
|
33
34
|
# @type [Boolean] constellation_role
|
@@ -36,15 +37,22 @@ module Comet
|
|
36
37
|
# @type [Array<String>] experimental_options
|
37
38
|
attr_accessor :experimental_options
|
38
39
|
|
40
|
+
# Unix timestamp, in seconds.
|
39
41
|
# @type [Number] server_start_time
|
40
42
|
attr_accessor :server_start_time
|
41
43
|
|
44
|
+
# A GUID that was randomly generated when this Comet Server started up. You can check this value to
|
45
|
+
# see if the Comet Server has restarted.
|
42
46
|
# @type [String] server_start_hash
|
43
47
|
attr_accessor :server_start_hash
|
44
48
|
|
49
|
+
# The current time on the Comet Server host machine. Unix timestamp, in seconds. You can check this
|
50
|
+
# value to see if clock drift is occuring.
|
45
51
|
# @type [Number] current_time
|
46
52
|
attr_accessor :current_time
|
47
53
|
|
54
|
+
# A hash derived from the Comet Server's serial number. You can check this value to see if two Comet
|
55
|
+
# Server endpoints point to an identical server.
|
48
56
|
# @type [String] server_license_hash
|
49
57
|
attr_accessor :server_license_hash
|
50
58
|
|
@@ -12,6 +12,7 @@ module Comet
|
|
12
12
|
# SessionKeyRegeneratedResponse is a typed class wrapper around the underlying Comet Server API data structure.
|
13
13
|
class SessionKeyRegeneratedResponse
|
14
14
|
|
15
|
+
# If the operation was successful, the status will be in the 200-299 range.
|
15
16
|
# @type [Number] status
|
16
17
|
attr_accessor :status
|
17
18
|
|
@@ -12,6 +12,7 @@ module Comet
|
|
12
12
|
# SourceConfig is a typed class wrapper around the underlying Comet Server API data structure.
|
13
13
|
class SourceConfig
|
14
14
|
|
15
|
+
# One of the ENGINE_BUILTIN_ constants
|
15
16
|
# @type [String] engine
|
16
17
|
attr_accessor :engine
|
17
18
|
|
@@ -27,18 +28,68 @@ module Comet
|
|
27
28
|
# @type [Number] modify_time
|
28
29
|
attr_accessor :modify_time
|
29
30
|
|
31
|
+
# Custom commands to run before the job
|
30
32
|
# @type [Array<String>] pre_exec
|
31
33
|
attr_accessor :pre_exec
|
32
34
|
|
35
|
+
# Custom commands to run after taking a disk snapshot
|
33
36
|
# @type [Array<String>] thaw_exec
|
34
37
|
attr_accessor :thaw_exec
|
35
38
|
|
39
|
+
# Custom commands to run after the job
|
36
40
|
# @type [Array<String>] post_exec
|
37
41
|
attr_accessor :post_exec
|
38
42
|
|
43
|
+
# Configuration for the selected Protected Item type. Each "Engine" supports
|
44
|
+
# different configuration options for the EngineProps values.
|
45
|
+
#
|
46
|
+
# For engine1/file, Comet understands the following EngineProp keys:
|
47
|
+
#
|
48
|
+
# - Any key starting with INCLUDE: A path that is included
|
49
|
+
# - Any key starting with EXCLUDE: An exclusion (glob format)
|
50
|
+
# - Any key starting with REXCLUDE: An exclusion (regular expression format)
|
51
|
+
# - Any key starting with PINCLUDE: A JSON string {"TopDirectory": "", "Value": ""}. TopDirectory is
|
52
|
+
# the path where starts to match the value; Value is an inclusion (glob format)
|
53
|
+
# - Any key starting with RINCLUDE: A JSON string {"TopDirectory": "", "Value": ""}. TopDirectory is
|
54
|
+
# the path where starts to match the value; Value is an inclusion (regular expression format)
|
55
|
+
# - Any key starting with SMBAUTH: A set of Windows network share credentials in WinSMBAuth JSON
|
56
|
+
# format
|
57
|
+
# - USE_WIN_VSS: If present, the 'Take filesystem snapshot' checkbox is checked
|
58
|
+
# - CONFIRM_EFS: If present, the 'Dismiss EFS warning' checkbox is checked
|
59
|
+
# - RESCAN_UNCHANGED: If present, the 'Rescan unchanged files' checkbox is checked
|
60
|
+
#
|
61
|
+
# For engine1/mssql, Comet understands the following EngineProp keys:
|
62
|
+
#
|
63
|
+
# - ALL_DATABASES: If present, include all databases with specified exclusions. If not present, only
|
64
|
+
# back up the specified inclusions
|
65
|
+
# - Any key starting with DATABASE- : A database that is included. Only valid if ALL_DATABASES is
|
66
|
+
# not present.
|
67
|
+
# - Any key starting with EXCEPT-DATABASE- : A database that is excluded. Only valid if
|
68
|
+
# ALL_DATABASES is present.
|
69
|
+
# - INSTANCE: The Microsoft SQL Server instance name
|
70
|
+
# - USERNAME: The username to connect to Microsoft SQL Server
|
71
|
+
# - PASSWORD: The password to connect to Microsoft SQL Server
|
72
|
+
# - AUTHMODE: Either "windows" or "native" (corresponding to the declared MSSQL_AUTH_WINDOWS and
|
73
|
+
# MSSQL_AUTH_NATIVE constant values). If not present, use native authentication if the USERNAME
|
74
|
+
# and/or PASSWORD fields are filled in, use windows authentication if they are blank
|
75
|
+
# - METHOD: Either "OLEDB_NATIVE" or "OLEDB_32" (corresponding to the declared
|
76
|
+
# MSSQL_METHOD_OLEDB_NATIVE and MSSQL_METHOD_OLEDB_32 constant values). If not present, defaults to
|
77
|
+
# Native
|
78
|
+
# - DIFFBASE: If present, take a "Full (base image)" backup job. Otherwise, take a "Full (copy
|
79
|
+
# only)" backup job.
|
80
|
+
# - DIFFERENTIAL: If present, take a "Differential increment" backup job. Otherwise, take a "Full
|
81
|
+
# (copy only)" backup job.
|
82
|
+
# - LOGTRUNC: If present, take a "Log (truncating)" backup job. Otherwise, take a "Full (copy only)"
|
83
|
+
# backup job.
|
84
|
+
# - LOGNOTRUNC: If present, take a "Log (no truncation)" backup job. Otherwise, take a "Full (copy
|
85
|
+
# only)" backup job.
|
86
|
+
#
|
39
87
|
# @type [Hash{String => String}] engine_props
|
40
88
|
attr_accessor :engine_props
|
41
89
|
|
90
|
+
# By default, backup jobs from this Protected Item will be subject
|
91
|
+
# to the overall retention policy for the Storage Vault. You can override the policy
|
92
|
+
# for specific Storage Vaults by putting their destination ID as a key here.
|
42
93
|
# @type [Hash{String => Comet::RetentionPolicy}] override_destination_retention
|
43
94
|
attr_accessor :override_destination_retention
|
44
95
|
|
@@ -12,24 +12,30 @@ module Comet
|
|
12
12
|
# SwiftDestinationLocation is a typed class wrapper around the underlying Comet Server API data structure.
|
13
13
|
class SwiftDestinationLocation
|
14
14
|
|
15
|
+
# Username or UserID or Application Credential name or Application Credential ID, or blank for token
|
16
|
+
# authentication
|
15
17
|
# @type [String] username
|
16
18
|
attr_accessor :username
|
17
19
|
|
20
|
+
# User Password, or Application Credential Key, or token if the Username field is blank
|
18
21
|
# @type [String] apikey
|
19
22
|
attr_accessor :apikey
|
20
23
|
|
21
24
|
# @type [String] region
|
22
25
|
attr_accessor :region
|
23
26
|
|
27
|
+
# Mandatory
|
24
28
|
# @type [String] auth_url
|
25
29
|
attr_accessor :auth_url
|
26
30
|
|
27
31
|
# @type [String] domain
|
28
32
|
attr_accessor :domain
|
29
33
|
|
34
|
+
# Tenant name (v2) or Project name (v3)
|
30
35
|
# @type [String] tenant
|
31
36
|
attr_accessor :tenant
|
32
37
|
|
38
|
+
# Project domain name (v3)
|
33
39
|
# @type [String] tenant_domain
|
34
40
|
attr_accessor :tenant_domain
|
35
41
|
|
@@ -40,6 +46,7 @@ module Comet
|
|
40
46
|
attr_accessor :trust_id
|
41
47
|
|
42
48
|
# @type [String] auth_token
|
49
|
+
# @deprecated This member has been deprecated since Comet version 17.8.0
|
43
50
|
attr_accessor :auth_token
|
44
51
|
|
45
52
|
# @type [String] prefix
|
@@ -12,6 +12,7 @@ module Comet
|
|
12
12
|
# TestResponse is a typed class wrapper around the underlying Comet Server API data structure.
|
13
13
|
class TestResponse
|
14
14
|
|
15
|
+
# If the operation was successful, the status will be in the 200-299 range.
|
15
16
|
# @type [Number] status
|
16
17
|
attr_accessor :status
|
17
18
|
|
@@ -12,9 +12,11 @@ module Comet
|
|
12
12
|
# TimeSpan is a typed class wrapper around the underlying Comet Server API data structure.
|
13
13
|
class TimeSpan
|
14
14
|
|
15
|
+
# SCHEDULE_FREQUENCY_<TYPE>
|
15
16
|
# @type [Number] frequency_type
|
16
17
|
attr_accessor :frequency_type
|
17
18
|
|
19
|
+
# Used for Periodic and Once Only
|
18
20
|
# @type [Number] seconds
|
19
21
|
attr_accessor :seconds
|
20
22
|
|
@@ -12,6 +12,7 @@ module Comet
|
|
12
12
|
# TotpRegeneratedResponse is a typed class wrapper around the underlying Comet Server API data structure.
|
13
13
|
class TotpRegeneratedResponse
|
14
14
|
|
15
|
+
# If the operation was successful, the status will be in the 200-299 range.
|
15
16
|
# @type [Number] status
|
16
17
|
attr_accessor :status
|
17
18
|
|
@@ -13,6 +13,7 @@ module Comet
|
|
13
13
|
# @deprecated This type has been deprecated since Comet version 21.12.0
|
14
14
|
class U2FRegistrationChallengeResponse
|
15
15
|
|
16
|
+
# If the operation was successful, the status will be in the 200-299 range.
|
16
17
|
# @type [Number] status
|
17
18
|
attr_accessor :status
|
18
19
|
|
@@ -10,11 +10,15 @@ require 'json'
|
|
10
10
|
module Comet
|
11
11
|
|
12
12
|
# UninstallConfig is a typed class wrapper around the underlying Comet Server API data structure.
|
13
|
+
# UninstallConfig allows configuring whether the target device will be uninstalled or not.
|
13
14
|
class UninstallConfig
|
14
15
|
|
16
|
+
# If this option is true, the target device will receive a message asking it to uninstall the Comet
|
17
|
+
# Backup app.
|
15
18
|
# @type [Boolean] uninstall_flag
|
16
19
|
attr_accessor :uninstall_flag
|
17
20
|
|
21
|
+
# This controls the "Remove all user settings from this device" option.
|
18
22
|
# @type [Boolean] remove_config_file
|
19
23
|
attr_accessor :remove_config_file
|
20
24
|
|
@@ -28,9 +28,12 @@ module Comet
|
|
28
28
|
# @type [Boolean] downgrade_newer
|
29
29
|
attr_accessor :downgrade_newer
|
30
30
|
|
31
|
+
# Choose whether this bulk upgrade campaign is allowed to interrupt a running backup job.
|
31
32
|
# @type [Boolean] force_upgrade_running
|
32
33
|
attr_accessor :force_upgrade_running
|
33
34
|
|
35
|
+
# If true, then the UserFilter will be used to restrict which accounts and devices will be eligible
|
36
|
+
# for the software update. If false, all users and devices will be eligible for the software update.
|
34
37
|
# @type [Boolean] apply_device_filter
|
35
38
|
attr_accessor :apply_device_filter
|
36
39
|
|
@@ -24,9 +24,12 @@ module Comet
|
|
24
24
|
# @type [Boolean] downgrade_newer
|
25
25
|
attr_accessor :downgrade_newer
|
26
26
|
|
27
|
+
# Choose whether this bulk upgrade campaign is allowed to interrupt a running backup job.
|
27
28
|
# @type [Boolean] force_upgrade_running
|
28
29
|
attr_accessor :force_upgrade_running
|
29
30
|
|
31
|
+
# If true, then the UserFilter will be used to restrict which accounts and devices will be eligible
|
32
|
+
# for the software update. If false, all users and devices will be eligible for the software update.
|
30
33
|
# @type [Boolean] apply_device_filter
|
31
34
|
attr_accessor :apply_device_filter
|
32
35
|
|
@@ -24,9 +24,12 @@ module Comet
|
|
24
24
|
# @type [Boolean] downgrade_newer
|
25
25
|
attr_accessor :downgrade_newer
|
26
26
|
|
27
|
+
# Choose whether this bulk upgrade campaign is allowed to interrupt a running backup job.
|
27
28
|
# @type [Boolean] force_upgrade_running
|
28
29
|
attr_accessor :force_upgrade_running
|
29
30
|
|
31
|
+
# If true, then the UserFilter will be used to restrict which accounts and devices will be eligible
|
32
|
+
# for the software update. If false, all users and devices will be eligible for the software update.
|
30
33
|
# @type [Boolean] apply_device_filter
|
31
34
|
attr_accessor :apply_device_filter
|
32
35
|
|
@@ -12,6 +12,8 @@ module Comet
|
|
12
12
|
# UserOnServer is a typed class wrapper around the underlying Comet Server API data structure.
|
13
13
|
class UserOnServer
|
14
14
|
|
15
|
+
# The server where this user was found. The 0-based indexes here correspond to the entries inside
|
16
|
+
# ConstellationRoleOptions->Servers.
|
15
17
|
# @type [Number] server_id
|
16
18
|
attr_accessor :server_id
|
17
19
|
|
@@ -13,15 +13,22 @@ module Comet
|
|
13
13
|
# This is the main data structure for a user's profile.
|
14
14
|
class UserProfileConfig
|
15
15
|
|
16
|
+
# The name for this account. It uniquely identifies this UserProfileConfig across the entire Comet
|
17
|
+
# Server. It cannot be changed directly.
|
16
18
|
# @type [String] username
|
17
19
|
attr_accessor :username
|
18
20
|
|
21
|
+
# A longer descriptive name for this account. It is not necessarily unique to the Comet Server. The
|
22
|
+
# end-user might be able to change it inside the Comet Backup desktop app.
|
19
23
|
# @type [String] account_name
|
20
24
|
attr_accessor :account_name
|
21
25
|
|
26
|
+
# Timezone in IANA format. Individual devices may declare a more specific timezone in the Devices
|
27
|
+
# field.
|
22
28
|
# @type [String] local_timezone
|
23
29
|
attr_accessor :local_timezone
|
24
30
|
|
31
|
+
# One of the supported languages, such as en_US (DEFAULT_LANGUAGE).
|
25
32
|
# @type [String] language_code
|
26
33
|
attr_accessor :language_code
|
27
34
|
|
@@ -29,12 +36,17 @@ module Comet
|
|
29
36
|
# @type [String] organization_id
|
30
37
|
attr_accessor :organization_id
|
31
38
|
|
39
|
+
# A list of email addresses to send reports to.
|
32
40
|
# @type [Array<String>] emails
|
33
41
|
attr_accessor :emails
|
34
42
|
|
43
|
+
# By default, all the email addresses in the Emails field will receieve the policy-default or
|
44
|
+
# server-wide-default style of email report. Add an override for a specific email address in here to
|
45
|
+
# allow customizing the email report that will be received.
|
35
46
|
# @type [Hash{String => Comet::UserCustomEmailSettings}] override_email_settings
|
36
47
|
attr_accessor :override_email_settings
|
37
48
|
|
49
|
+
# This option can be used to control whether any email reports are sent.
|
38
50
|
# @type [Boolean] send_email_reports
|
39
51
|
attr_accessor :send_email_reports
|
40
52
|
|
@@ -46,27 +58,41 @@ module Comet
|
|
46
58
|
# @type [Hash{String => Comet::SourceConfig}] sources
|
47
59
|
attr_accessor :sources
|
48
60
|
|
61
|
+
# Schedules
|
49
62
|
# @type [Hash{String => Comet::BackupRuleConfig}] backup_rules
|
50
63
|
attr_accessor :backup_rules
|
51
64
|
|
65
|
+
# Devices
|
66
|
+
# To revoke a device, use the AdminRevokeDevice API instead of accessing these fields directly. This
|
67
|
+
# API can also remove associated Protected Items, uninstall the remote device, and disconnect its
|
68
|
+
# live connection.
|
52
69
|
# @type [Hash{String => Comet::DeviceConfig}] devices
|
53
70
|
attr_accessor :devices
|
54
71
|
|
55
72
|
# @type [Boolean] is_suspended
|
56
73
|
attr_accessor :is_suspended
|
57
74
|
|
75
|
+
# Unix timestamp in seconds. Zero if the device is not suspended.
|
58
76
|
# @type [Number] last_suspended
|
59
77
|
attr_accessor :last_suspended
|
60
78
|
|
79
|
+
# A limit on the total Size of all Protected Items in this account. The number of bytes should be
|
80
|
+
# configured in AllProtectedItemsQuotaBytes.
|
61
81
|
# @type [Boolean] all_protected_items_quota_enabled
|
62
82
|
attr_accessor :all_protected_items_quota_enabled
|
63
83
|
|
84
|
+
# A limit on the total Size of all Protected Items in this account. It is enforced if
|
85
|
+
# AllProtectedItemsQuotaEnabled is true.
|
64
86
|
# @type [Number] all_protected_items_quota_bytes
|
65
87
|
attr_accessor :all_protected_items_quota_bytes
|
66
88
|
|
89
|
+
# A limit on the total number of devices registered in this account. Set to zero to allow unlimited
|
90
|
+
# devices.
|
67
91
|
# @type [Number] maximum_devices
|
68
92
|
attr_accessor :maximum_devices
|
69
93
|
|
94
|
+
# A limit on the total number of Office 365 Protected Accounts across all Office 365 Protected Items
|
95
|
+
# in this account. Set to zero to allow unlimited Office 365 Protected Accounts.
|
70
96
|
# @type [Number] quota_office_365protected_accounts
|
71
97
|
attr_accessor :quota_office_365protected_accounts
|
72
98
|
|
@@ -76,6 +102,8 @@ module Comet
|
|
76
102
|
# @type [String] policy_id
|
77
103
|
attr_accessor :policy_id
|
78
104
|
|
105
|
+
# The Policy field contains a read-only copy of the effective Policy that is applied to this user
|
106
|
+
# account.
|
79
107
|
# @type [Comet::UserPolicy] policy
|
80
108
|
attr_accessor :policy
|
81
109
|
|
@@ -87,6 +115,9 @@ module Comet
|
|
87
115
|
# @type [String] password_hash
|
88
116
|
attr_accessor :password_hash
|
89
117
|
|
118
|
+
# If this field is empty, the "Allow administrator to reset my password" feature is turned off. If
|
119
|
+
# this field is filled, it contains a cryptographic root of trust that can decrypt and re-encrypt
|
120
|
+
# other secrets in this profile.
|
90
121
|
# @type [String] password_recovery
|
91
122
|
attr_accessor :password_recovery
|
92
123
|
|
@@ -102,15 +133,20 @@ module Comet
|
|
102
133
|
# @type [String] totpkey
|
103
134
|
attr_accessor :totpkey
|
104
135
|
|
136
|
+
# This field is available in Comet 20.3.4 and later.
|
105
137
|
# @type [Boolean] require_password_change
|
106
138
|
attr_accessor :require_password_change
|
107
139
|
|
140
|
+
# Unix timestamp in seconds
|
108
141
|
# @type [Number] create_time
|
109
142
|
attr_accessor :create_time
|
110
143
|
|
144
|
+
# A random GUID that is allocated when the user profile is created for the first time. You can use
|
145
|
+
# this to help disambiguate users with the same username across multiple Comet Servers.
|
111
146
|
# @type [String] creation_guid
|
112
147
|
attr_accessor :creation_guid
|
113
148
|
|
149
|
+
# Additional server-wide settings that are enforced for this user profile
|
114
150
|
# @type [Comet::UserServerConfig] server_config
|
115
151
|
attr_accessor :server_config
|
116
152
|
|
@@ -12,12 +12,16 @@ module Comet
|
|
12
12
|
# VMDKSnapshotViewOptions is a typed class wrapper around the underlying Comet Server API data structure.
|
13
13
|
class VMDKSnapshotViewOptions
|
14
14
|
|
15
|
+
# Request a list of stored objects in vmdk file. It should be always true for restoring single files
|
16
|
+
# from vmdk file
|
15
17
|
# @type [Boolean] enabled
|
16
18
|
attr_accessor :enabled
|
17
19
|
|
20
|
+
# The vmdk filename inside subdirectory of disk image, should be end with .vmdk
|
18
21
|
# @type [String] partition_guid
|
19
22
|
attr_accessor :partition_guid
|
20
23
|
|
24
|
+
# Browse objects' paths inside vmdk file
|
21
25
|
# @type [String] list_path
|
22
26
|
attr_accessor :list_path
|
23
27
|
|
@@ -12,6 +12,7 @@ module Comet
|
|
12
12
|
# WebAuthnRegistrationChallengeResponse is a typed class wrapper around the underlying Comet Server API data structure.
|
13
13
|
class WebAuthnRegistrationChallengeResponse
|
14
14
|
|
15
|
+
# If the operation was successful, the status will be in the 200-299 range.
|
15
16
|
# @type [Number] status
|
16
17
|
attr_accessor :status
|
17
18
|
|
@@ -12,15 +12,21 @@ module Comet
|
|
12
12
|
# WinSMBAuth is a typed class wrapper around the underlying Comet Server API data structure.
|
13
13
|
class WinSMBAuth
|
14
14
|
|
15
|
+
# The UNC path for the Windows network share (SMB).
|
15
16
|
# @type [String] share_path
|
16
17
|
attr_accessor :share_path
|
17
18
|
|
19
|
+
# The username to log in to the Windows network share (SMB).
|
18
20
|
# @type [String] username
|
19
21
|
attr_accessor :username
|
20
22
|
|
23
|
+
# The password might be hashed. To set this in cleartext, set PasswordFormat to 0
|
24
|
+
# (PASSWORD_FORMAT_PLAINTEXT).
|
21
25
|
# @type [String] password
|
22
26
|
attr_accessor :password
|
23
27
|
|
28
|
+
# The hash algorithm that is used for the Password field. It is one of the PASSWORD_FORMAT_
|
29
|
+
# constants.
|
24
30
|
# @type [Number] password_format
|
25
31
|
attr_accessor :password_format
|
26
32
|
|