openapi: 3.2.0 info: description: 'This API list provides operations for interfacing with the Cohesity Cluster.' title: Cohesity REST Clone Refresh Tasks API version: '1.0' servers: - url: https:///irisservices/api/v1 tags: - name: CloneRefreshTasks paths: /public/restore/applicationsClone/refresh: post: description: 'Returns the created Clone Refresh Task which refreshes the clone with specified data.' tags: - CloneRefreshTasks summary: Create a Clone Refresh Task to refresh the clone with the new data operationId: CreateCloneRefreshTask responses: '201': $ref: '#/components/responses/CreateCloneRefreshTaskResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/CloneRefreshRequest' description: Request to create a Clone Refresh Task. required: true components: schemas: VlanParameters: description: Specifies VLAN parameters for the restore operation. type: object title: VLAN Parameters. properties: disableVlan: description: 'Specifies whether to use the VIPs even when VLANs are configured on the Cluster. If configured, VLAN IP addresses are used by default. If VLANs are not configured, this flag is ignored. Set this flag to true to force using the partition VIPs when VLANs are configured on the Cluster.' type: - boolean - 'null' x-go-name: DisableVlan interfaceName: description: 'Specifies the physical interface group name to use for mounting Cohesity''s view on the remote host. If specified, Cohesity hostname or the IP address on this VLAN is used.' type: - string - 'null' x-go-name: InterfaceName vlan: description: 'Specifies the VLAN to use for mounting Cohesity''s view on the remote host. If specified, Cohesity hostname or the IP address on this VLAN is used.' type: - integer - 'null' format: int32 x-go-name: Vlan x-go-package: cohesity/iris/server/data/public HdfsRecoverJobParams: description: 'Contains any additional hdfs environment specific params for the recover job.' type: object properties: hdfsExcludePattern: description: Any path/Glob pattern from HDFS that is to excluded. type: - array - 'null' items: type: string x-go-name: HdfsExcludePattern hdfsRecoverPattern: description: Any path/Glob pattern from HDFS that is to recovered. type: - array - 'null' items: type: string x-go-name: HdfsRecoverPattern targetDirectory: description: A target directory where all the recovered entities are created type: - string - 'null' x-go-name: TargetDirectory x-go-package: magneto/base/nosql.pb RemoteScriptProto: description: 'Message to encapsulate the information of script that can be executed either before or after the backup is taken.' type: object properties: remoteHostParams: description: 'Connector params for the remote host where script is located and is executed.' $ref: '#/components/schemas/RemoteHostConnectorParams' script: description: Contains script path and its optional params. $ref: '#/components/schemas/ScriptPathAndParams' status: description: Execution status of the script. $ref: '#/components/schemas/ScriptExecutionStatus' x-go-package: magneto/base/magneto.pb UniversalId: description: 'Specifies an id for an object that is unique across Cohesity Clusters. The id is composite of all the ids listed below.' type: object title: Unique Global Id. properties: clusterId: description: Specifies the Cohesity Cluster id where the object was created. type: - integer - 'null' format: int64 x-go-name: ClusterId clusterIncarnationId: description: 'Specifies an id for the Cohesity Cluster that is generated when a Cohesity Cluster is initially created.' type: - integer - 'null' format: int64 x-go-name: ClusterIncarnationId id: description: 'Specifies a unique id assigned to an object (such as a Job) by the Cohesity Cluster.' type: - integer - 'null' format: int64 x-go-name: Id x-go-package: cohesity/iris/server/data/public HdfsConnectParams: description: 'Specifies an Object containing information about a registered Hdfs source.' type: object title: Hdfs Connect Params. properties: hadoopDistribution: description: 'Specifies the Hadoop Distribution. Hadoop distribution. ''CDH'' indicates Hadoop distribution type Cloudera. ''HDP'' indicates Hadoop distribution type Hortonworks.' type: - string - 'null' enum: - CDH - HDP x-go-name: HadoopDistribution hadoopVersion: description: Specifies the Hadoop version type: - string - 'null' x-go-name: HadoopVersion kerberosPrincipal: description: Specifies the kerberos principal. type: - string - 'null' x-go-name: KerberosPrincipal namenode: description: Specifies the Namenode host or Nameservice. type: - string - 'null' x-go-name: Namenode port: description: Specifies the Webhdfs Port type: - integer - 'null' format: int32 x-go-name: Port x-go-package: cohesity/iris/server/data/public MountVolumesVMwareParams: type: object title: VMware specific additional params. properties: bringDisksOnline: description: 'Optional setting which will determine if the volumes need to be onlined within the target environment after attaching the disks. NOTE: If this is set to true, then target_entity_credentials must be specified and VMware tools must be installed on the VM.' type: - boolean - 'null' x-go-name: BringDisksOnline targetEntityCredentials: description: 'Credentials to access the target entity such as a VM. This is not required if bring_disks_online is set to false.' $ref: '#/components/schemas/Credentials' x-go-package: magneto/base/magneto.pb HiveRecoverJobParams: description: 'Contains any additional hive environment specific params for the recover job.' type: object properties: hdfsConnectParams: description: Additional hdfs connection params required for Hive Backup. $ref: '#/components/schemas/HdfsConnectParams' suffix: description: A suffix that is to be applied to all recovered entities type: - string - 'null' x-go-name: Suffix x-go-package: magneto/base/nosql.pb Preferences: type: object title: User's preferences. properties: locale: description: 'Locale reflects the language settings of the user. Populate using the user preferences stored in Scribe for the user wherever needed.' type: - string - 'null' x-go-name: Locale x-go-package: cohesity/iris/server/data/public ADObjectRestoreStatus: type: object title: AD object restore status for an object such as user, computer, group, etc. properties: destGuid: description: 'Destination guid string of the AD object that is newly created on production AD corresponding to ''source_guid''. If the object was restored from production AD recycle Bin, this value can be empty or set to same value as ''source_guid''. If this value is non-empty and is different from source_guid, implying production AD object is a new object created in production AD as part of restore.' type: - string - 'null' x-go-name: DestGuid objectFlags: description: Object result flags of type ADObjectFlags. type: - integer - 'null' format: uint32 x-go-name: ObjectFlags propertyStatusVec: description: AD object attribute(property) restore status vector. type: - array - 'null' items: $ref: '#/components/schemas/ADObjectRestoreStatus_ADAttributeRestoreStatus' x-go-name: PropertyStatusVec sourceGuid: description: 'Source guid of AD object that was restored. This will not be empty. This is populated from the source of request argument.' type: - string - 'null' x-go-name: SourceGuid status: description: 'Error status at object level. Callers should inspect ''property_status_vec'' for individual attribute restore failures. The attribute restore failures will not be rolled into this status.' $ref: '#/components/schemas/ErrorProto' timetakenMs: description: 'Time taken in milliseconds to restore the individual object or attribute update. If this object restore was part of a batch, it shows the time taken once the operation was dispatched to AD for the object. This time can be useful in answering why some objects took long time to restore. Note that this time is not the elapsed time when the request was made from Magneto.' type: - integer - 'null' format: uint64 x-go-name: TimetakenMs x-go-package: magneto/agents/windows/stub/ad_param.pb Value: description: Specifies a data type and data field used to store data. type: object title: Value. properties: data: $ref: '#/components/schemas/Value_Data' type: description: 'Specifies the type of value. 0 specifies a data point of type Int64. 1 specifies a data point of type Double. 2 specifies a data point of type String. 3 specifies a data point of type Bytes.' type: - integer - 'null' format: int32 x-go-name: Type x-go-package: stats/base/stats_types.pb CassandraAdditionalParams: description: 'Contains additional parameters required by the agents to backup data from Cassandra.' type: object properties: cassandraClasspathSuffix: description: Cassandra classpath suffix. type: - string - 'null' x-go-name: CassandraClasspathSuffix cassandraPartitioner: description: Required in compaction. type: - string - 'null' x-go-name: CassandraPartitioner cassandraVersion: description: 'Cassandra and DSE Versions. Discovery code will attempt to discover the versions.' type: - string - 'null' x-go-name: CassandraVersion dataCenterVec: description: Data center information is required for backup and recovery. type: - array - 'null' items: type: string x-go-name: DataCenterVec dseSolrInfo: description: In case this Cassandra has a Solr node. $ref: '#/components/schemas/DSESolrInfo' dseVersion: type: - string - 'null' x-go-name: DseVersion tieredStorageDirsMap: description: Map of nodes to tiered storage directories type: - array - 'null' items: $ref: '#/components/schemas/NodeToTieredStorageDirectoriesMap' x-go-name: TieredStorageDirsMap x-go-package: magneto/base/nosql.pb Credentials: description: Specifies credentials to access a target source. type: object title: Credentials. properties: password: description: Specifies password of the username to access the target source. type: - string - 'null' x-go-name: Password username: description: Specifies username to access the target source. type: - string - 'null' x-go-name: Username x-go-package: cohesity/iris/server/data/public RecoverVirtualDiskParams: type: object title: Contains information needed when recovering virtual disks. properties: powerOffVmBeforeRecovery: description: Whether to power-off the VM before recovering virtual disks. type: - boolean - 'null' x-go-name: PowerOffVmBeforeRecovery powerOnVmAfterRecovery: description: Whether to power-on the VM after recovering virtual disks. type: - boolean - 'null' x-go-name: PowerOnVmAfterRecovery targetEntity: description: Target entity to which the disks should be attached. $ref: '#/components/schemas/EntityProto' virtualDiskMappings: type: - array - 'null' items: $ref: '#/components/schemas/RecoverVirtualDiskParams_VirtualDiskMapping' x-go-name: VirtualDiskMappings x-go-package: magneto/base/magneto.pb ClusterConfigProto_QoSMapping: description: 'If a new enum value is added to either QoSMapping.Type or QoSPrincipal.Priority in a future version, direct upgrades must be disallowed from a pre-2.5 version to that version (without upgrading to 2.5 first). Contact nexus team for getting an appropriate restriction into the upgrade compatibility list.' type: object title: 'Mapping from a QoSContext to a QoSPrincipal. NOTE: ''type'' and ''priority'' fields have been converted from required to optional in v2.5. Adding a new value to an enumeration for which there is a required field in any message breaks the software upgrade process. During an upgrade, it is common for different cluster nodes to run different versions of the code for a short period of time. So if a node running a newer version of the code goes ahead and sets the required field to the newly added enum value, the old code running on other nodes may go into crash loops due to protobuf parse failures.' properties: principalId: description: Principal id of the QoS principal to which qos_context maps to. type: - integer - 'null' format: int64 x-go-name: PrincipalId qosContext: $ref: '#/components/schemas/ClusterConfigProto_QoSMapping_QoSContext' x-go-package: configs/cluster_config.pb OracleDBConfig_PfileParameterMapEntry: type: object properties: key: type: - string - 'null' x-go-name: Key value: type: - string - 'null' x-go-name: Value x-go-package: magneto/base/magneto.pb RestoreVMwareVMParams: type: object title: This message defines the VMware specific VMs restore params. properties: catalogUuid: description: 'Specifies the name of the catalog for vapp template recovery. This is applicable for recovery to a VCD.' type: - string - 'null' x-go-name: CatalogUuid copyRecovery: description: Whether to perform copy recovery instead of instant recovery. type: - boolean - 'null' x-go-name: CopyRecovery datastoreEntityVec: description: Datastore entities if the restore is to alternate location. type: - array - 'null' items: $ref: '#/components/schemas/EntityProto' x-go-name: DatastoreEntityVec preserveCustomAttributesDuringClone: description: Whether to preserve custom attributes for the clone op. type: - boolean - 'null' x-go-name: PreserveCustomAttributesDuringClone preserveTagsDuringClone: description: Whether to preserve tags for the clone op. type: - boolean - 'null' x-go-name: PreserveTagsDuringClone resourcePoolEntity: description: Resource pool entity if the restore is to alternate location. $ref: '#/components/schemas/EntityProto' storageProfileName: description: 'This is only populated for VCD restore to alternate location. It contains the name of the destination storage profile.' type: - string - 'null' x-go-name: StorageProfileName storageProfileVcdUuid: description: 'This is only populated for VCD restore to alternate location. It contains the vcd uuid of the destination storage profile.' type: - string - 'null' x-go-name: StorageProfileVcdUuid targetDatastoreFolder: description: 'Folder where the restore datastore should be created. This is applicable only when the VMs are being cloned.' $ref: '#/components/schemas/EntityProto' targetVmFolder: description: 'Folder where the VMs should be created. This is applicable only when the VMs are being restored to an alternate location or if clone is being performed.' $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/magneto.pb DeployVMsToCloudTaskStateProto: type: object title: Persistent state for a convert and deploy VMs to cloud task. properties: deployVmsToCloudParams: description: 'This captures all the necessary information required to deploy VMs to cloud.' $ref: '#/components/schemas/DeployVMsToCloudParams' x-go-package: magneto/master/base/master.pb NoSqlConnectParams: type: object properties: cassandraAdditionalParams: description: Additional params required for cassandra backup. $ref: '#/components/schemas/CassandraAdditionalParams' cassandraConnectParams: description: 'Connect params for connecting to cassandra cluster. Set only if env_type is kCassandra.' $ref: '#/components/schemas/CassandraConnectParams' couchbaseConnectParams: description: 'Additional params for connecting to couchbase cluster. Set only if env_type is kCouchbase.' $ref: '#/components/schemas/CouchbaseConnectParams' hbaseConnectParams: description: 'Additional params for connecting to hbase cluster. Set only if env_type is kHBase.' $ref: '#/components/schemas/HBaseConnectParams' hdfsConnectParams: description: 'Additional params for connecting to hdfs cluster. Set only if env_type is kHdfs.' $ref: '#/components/schemas/HdfsConnectParams' hiveConnectParams: description: 'Additional params for connecting to hive cluster. Set only if env_type is kHive.' $ref: '#/components/schemas/HiveConnectParams' mongodbAdditionalParams: description: Additional params required for mongodb backup. $ref: '#/components/schemas/MongoDBAdditionalParams' mongodbConnectParams: description: 'Additional params for connecting to mongodb cluster. Set only if env_type is kMongoDB.' $ref: '#/components/schemas/MongoDBConnectParams' x-go-package: magneto/base/magneto.pb UuidConfigProto: type: object title: Proto to specify UUID config of an object. properties: preserveUuid: type: - boolean - 'null' x-go-name: PreserveUuid x-go-package: magneto/base/magneto.pb VolumeInfo_DiskInfo_PhysicalRange: type: object title: This message represents a physical contiguous range in disk file. properties: length: description: Length of this range in bytes. type: - integer - 'null' format: int64 x-go-name: Length offset: description: Offset of this range in disk file from beginning of file. type: - integer - 'null' format: int64 x-go-name: Offset x-go-package: yoda/base/volume_info.pb NoSqlRestoreObject: type: object properties: objectRestorePropertiesMap: description: 'Key-Value pair for properties to apply on restore object. Ex. Compaction for cassandra or ShardKeyJson for Mongo.' type: - array - 'null' items: $ref: '#/components/schemas/NoSqlRestoreObject_ObjectRestorePropertiesMapEntry' x-go-name: ObjectRestorePropertiesMap objectUuid: description: Uuid of the object to be restored. type: - string - 'null' x-go-name: ObjectUuid rename: description: The new name of the object after restore. type: - string - 'null' x-go-name: Rename x-go-package: magneto/base/nosql.pb ViewIdMappingProto_ProtocolAccessInfo: type: object properties: iscsiAccess: description: Access control for iSCSI protocol for this view. type: - integer - 'null' format: int32 x-go-name: IscsiAccess nfsAccess: description: Access control for NFS protocol for this view. type: - integer - 'null' format: int32 x-go-name: NfsAccess s3Access: description: Access control for S3 protocol for this view. type: - integer - 'null' format: int32 x-go-name: S3Access smbAccess: description: Access control for SMB protocol for this view. type: - integer - 'null' format: int32 x-go-name: SmbAccess swiftAccess: description: Access control for Swift protocol for this view. type: - integer - 'null' format: int32 x-go-name: SwiftAccess x-go-package: bridge/view_keeper/view_metadata.pb DestroyMountVolumesTaskInfoProto: type: object title: Message that captures the destroy mount volumes task state. properties: error: description: If an error is encountered during destroy it is set here. $ref: '#/components/schemas/ErrorProto' finished: description: This will be set to true if the task is complete on the slave. type: - boolean - 'null' x-go-name: Finished hostName: description: 'This is the host name of the ESXi host. It is used if magneto_vmware_use_fqdn_for_guest_file_operations is set.' type: - string - 'null' x-go-name: HostName mountVolumesInfoProto: description: 'This contains the mount volumes info proto and the associated setup restore disks state. This starts out with contents from the original mount volumes info task, but later gets mutated by slave to contain destroy related information.' $ref: '#/components/schemas/MountVolumesInfoProto' slaveTaskStartTimeUsecs: description: This is the timestamp at which the slave task started. type: - integer - 'null' format: int64 x-go-name: SlaveTaskStartTimeUsecs targetEntity: description: The target entity on which the mount volumes operation was performed. $ref: '#/components/schemas/EntityProto' useExistingAgent: description: 'This will be set to true in two cases: 1. If persistent agent was used for IVM. 2. If user chose ephemeral agent during IVM but the host already had persistent agent installed.' type: - boolean - 'null' x-go-name: UseExistingAgent x-go-package: magneto/base/magneto.pb PerformRestoreJobStateProto: description: 'Proto to define the persistent information of a wrapper restore job that spawns multiple child restore tasks.' type: object properties: admittedTimeUsecs: description: 'The time at which the restore job was admitted to run on a Magneto master. This field will be set only after the status changes to ''kAdmitted''. Using this field, amount of time spent in the waiting/queued state and the amount of time taken taken to actually run the job can be determined. wait time = admitted_time_usecs - start_time_usecs run time = end_time_usecs - admitted_time_usecs' type: - integer - 'null' format: int64 x-go-name: AdmittedTimeUsecs cancellationRequested: description: Whether this restore job has a pending cancellation request. type: - boolean - 'null' x-go-name: CancellationRequested continueRestoreOnError: description: 'Whether to continue with the restore operation if restore of any object fails.' type: - boolean - 'null' x-go-name: ContinueRestoreOnError deployVmsToCloudTaskState: description: 'This contains information regarding deploy vm to cloud task state. This is set for restore type kConvertAndDeployVMs and kDeployVms.' $ref: '#/components/schemas/DeployVMsToCloudTaskStateProto' endTimeUsecs: description: 'If the restore job has finished, this field contains the end time for the job.' type: - integer - 'null' format: int64 x-go-name: EndTimeUsecs error: description: The error encountered by job (if any). Only valid if the job has finished. $ref: '#/components/schemas/ErrorProto' name: description: The name of the restore job. type: - string - 'null' x-go-name: Name nosqlConnectParams: description: Parameters to connect to destination nosql parent entity. $ref: '#/components/schemas/NoSqlConnectParams' nosqlRecoverJobParams: description: Additional parameters for the recovery job to send to imanis server. $ref: '#/components/schemas/NoSqlRecoverJobParams' objects: description: 'Information on the exact set of objects being restored (along with snapshots they are being recovered from). Even if the user wanted to restore an entire job form the latest snapshot, this will have individual objects and the exact snapshot they are bein restored from. If specified, this can only have leaf-level entities.' type: - array - 'null' items: $ref: '#/components/schemas/RestoreObject' x-go-name: Objects parentSourceConnectionParams: description: A way to connect to the parent source. $ref: '#/components/schemas/ConnectorParams' physicalFlrParallelRestore: description: 'If enabled, magneto physical file restore will be enabled via job framework' type: - boolean - 'null' x-go-name: PhysicalFlrParallelRestore powerStateConfig: description: 'The power state configuration to be applied to the restored object. Please refer to comments for the field CreateRestoreTaskArg.power_state_config for more details.' $ref: '#/components/schemas/PowerStateConfigProto' preserveTags: description: 'Whether to preserve tags for the clone op. This field is currently used by HyperV and VMWare.' type: - boolean - 'null' x-go-name: PreserveTags progressMonitorTaskPath: description: Root path of a Pulse task tracking the progress of the restore job. type: - string - 'null' x-go-name: ProgressMonitorTaskPath renameRestoredObjectParam: description: 'List of env and action type for which this field is applicable are: AWS: kCloneVMs, kRecoverVMs.' title: 'By default, objects are restored with their original name. This field can be used to specify the transformation ( i.e prefix/suffix) to be applied to the source object name to derive the new name of the restored object.' $ref: '#/components/schemas/RenameObjectParamProto' renameRestoredVappParam: description: 'An optional parameter to specify how restored vApps(kVirtualApp) are renamed. Please refer to comments for the field CreateRestoreTaskARg.rename_restored_vapp_param for more details.' $ref: '#/components/schemas/RenameObjectParamProto' restoreAcropolisVmsParams: description: 'This field defines the Acropolis specific params for restore task of type kRecoverVMs.' $ref: '#/components/schemas/RestoreAcropolisVMsParams' restoreJobId: description: A globally unique id for this restore job. type: - integer - 'null' format: int64 x-go-name: RestoreJobId restoreKubernetesNamespacesParams: description: 'This field defines the kubernetes specific params for restore task of type kRecoverNamespaces.' $ref: '#/components/schemas/RestoreKubernetesNamespacesParams' restoreKvmVmsParams: description: 'This field defines the KVM specific params for restore task of type kRecoverVMs.' $ref: '#/components/schemas/RestoreKVMVMsParams' restoreParentSource: description: 'An optional registered parent source to which objects are to be restored. If not specified, objects are restored back to the original source that was managing the objects. If ''restored_to_different_source'' is set to true, then this field must be specified.' $ref: '#/components/schemas/EntityProto' restorePublicFoldersParams: description: 'This field defines the O365 Public Folders specific params for restore task of type kRecoverO365PublicFolders.' $ref: '#/components/schemas/RestoreO365PublicFoldersParams' restoreSiteParams: description: 'This field defines o365 site specific params for restore job of type kRecoverSites.' $ref: '#/components/schemas/RestoreSiteParams' restoreTaskStateProtoTmpl: description: 'This will be optionally populated for certain type of restores (FLR for now) and can be used as a template proto while creating the actual restore task later.' $ref: '#/components/schemas/PerformRestoreTaskStateProto' restoreTaskVec: description: 'Even if the user wanted to restore an entire job from the latest snapshot, this will have info of all the individual objects.' type: - array - 'null' items: $ref: '#/components/schemas/PerformRestoreJobStateProto_RestoreTask' x-go-name: RestoreTaskVec restoreVmwareVmParams: description: 'This field defines the VMware specific params for restore task of type kCloneVMs and kRecoverVMs.' $ref: '#/components/schemas/RestoreVMwareVMParams' restoredObjectsNetworkConfig: description: This is populated for VMware environment. $ref: '#/components/schemas/RestoredObjectNetworkConfigProto' restoredToDifferentSource: description: Whether restore is being performed to a different parent source. type: - boolean - 'null' x-go-name: RestoredToDifferentSource startTimeUsecs: description: The start time for this restore job. type: - integer - 'null' format: int64 x-go-name: StartTimeUsecs status: description: Status of the restore job. type: - integer - 'null' format: int32 x-go-name: Status type: description: The type of restore being performed. type: - integer - 'null' format: int32 x-go-name: Type user: description: The user who requested this restore job. type: - string - 'null' x-go-name: User userInfo: description: Specifies information about the user who made the request. $ref: '#/components/schemas/UserInformation' vcdConfig: description: The params to use while recovering a vcd entity. $ref: '#/components/schemas/RestoredObjectVCDConfigProto' viewBoxId: description: The view box id to which the restore job belongs to. type: - integer - 'null' format: int64 x-go-name: ViewBoxId warnings: description: 'Populate warnings on the job if any. The warning messages are propagated from the child restore tasks upon completion of the task.' type: - array - 'null' items: $ref: '#/components/schemas/ErrorProto' x-go-name: Warnings x-go-package: magneto/master/base/master.pb ACLProto_Grant: type: object title: Message to define a grantee and its permission. properties: grantee: description: 'Identifier of a grantee. It can be either a registered user or one of Amazon S3 predefined group.' $ref: '#/components/schemas/GranteeProto' permissionVec: description: Vector of permission granted to this grantee. type: - array - 'null' items: type: integer format: int32 x-go-name: PermissionVec x-go-package: bridge/s3_portal/base/s3_metadata.pb S3BucketConfigProto: type: object title: Proto to define the config/metadata of a S3 bucket. properties: acl: description: ACL of the bucket. $ref: '#/components/schemas/ACLProto' lifecycleConfig: description: 'Lifecycle policy of the bucket. If not specified, no lifecycle management is performed for objects in this bucket.' $ref: '#/components/schemas/LifecycleConfigProto' ownerInfo: description: Information about the bucket owner. $ref: '#/components/schemas/OwnerInfo' protocolType: description: Protocol type of this bucket. type: - integer - 'null' format: int32 x-go-name: ProtocolType swiftContainerTag: description: Swfit container tagging information. $ref: '#/components/schemas/SwiftContainerTaggingProto' tagMap: description: 'Tags (or labels) assigned to the bucket. Tags are set of pairs.' type: - array - 'null' items: $ref: '#/components/schemas/S3BucketConfigProto_TagMapEntry' x-go-name: TagMap versioningState: type: - integer - 'null' format: int32 x-go-name: VersioningState x-go-package: bridge/s3_portal/base/s3_metadata.pb RestoreInfoProto: description: 'Each available extension is listed below along with the location of the proto file (relative to magneto/connectors) where it is defined. The extension applies to both RestoreInfoProto as well as RestoreEntity. RestoreInfoProto extension Location Extension ============================================================================= vmware::RestoreInfo::vmware_restore_info vmware/vmware.proto 100 sql::RestoreInfo::sql_restore_info sql/sql.proto 101 pure::RestoreInfo::pure_restore_info pure/pure.proto 102 azure::RestoreInfo::azure_restore_info azure/azure.proto 103 file::RestoreInfo::file_restore_info file/file.proto 104 hyperv::RestoreInfo::hyperv_restore_info hyperv/hyperv.proto 105 acropolis::RestoreInfo::acropolis_restore_info acropolis/acropolis.proto 106 kvm::RestoreInfo::kvm_restore_info kvm/kvm.proto 107 aws::RestoreInfo::aws_restore_info aws/aws.proto 108 physical::RestoreInfo::physical_restore_info physical.proto 109 oracle::RestoreInfo::oracle_restore_info oracle/oracle.proto 110 outlook::RestoreInfo::outlook_restore_info outlook/outlook.proto 111 gcp::RestoreInfo::gcp_restore_info gcp/gcp.proto 112 ad::RestoreInfo::ad_restore_info ad/ad.proto 113 kubernetes::RestoreInfo::kubernetes_restore_info kubernetes/kubernetes.proto 114 one_drive::RestoreInfo::one_drive_restore_info ms_graph/graph.proto 115 cdp::RestoreInfo::cdp_restore_info cdp.proto 116 exchange::RestoreInfo::exchange_restore_info exchange/exchange.proto 117 imanis::RestoreInfo::nosql_recovery_info imanis/nosql.proto 118 o365::RestoreInfo::o365_restore_info o365/o365.proto 119 o365::RestoreInfo::o365_one_drive_restore_info o365/o365.proto 120 o365::PublicFolderRestoreInfoProto::public_folder_restore_info o365/o365.proto 121 ============================================================================= RestoreInfoProto.RestoreEntity extension Location Extension ============================================================================= vmware::RestoreEntityInfo::vmware_restore_entity_info vmware/vmware.proto 100 azure::RestoreEntityInfo::azure_restore_entity_info azure/azure.proto 101 hyperv::RestoreEntityInfo::hyperv_restore_entity_info hyperv/hyperv.proto 102 acropolis::RestoreEntityInfo::acropolis_restore_entity_info acropolis/acropolis.proto 103 kvm::RestoreEntityInfo::kvm_restore_entity_info kvm/kvm.proto 104 aws::RestoreEntityInfo::aws_restore_entity_info aws/aws.proto 105 outlook::RestoreEntityInfo::outlook_restore_entity_info outlook/outlook.proto 106 gcp::RestoreEntityInfo::gcp_restore_entity_info gcp/gcp.proto 107 kubernetes::RestoreEntityInfo::kubernetes_restore_entity_info kuebrnetes/kubernetes.proto 108 one_drive::RestoreEntityInfo::one_drive_restore_entity_info ms_graph/graph.proto 109 imanis::RestoreEntityInfo::nosql_restore_entity_info imanis/nosql.proto 110 site::RestoreEntityInfo::site_restore_entity_info ms_graph/graph.proto 111 =============================================================================' type: object title: 'Message that encapsulates information about restore tasks for any of the environments we support. Environment specific restore infos are defined as extensions to this proto.' properties: postScriptStatus: description: Captures the execution status of post script. $ref: '#/components/schemas/ScriptExecutionStatus' preScriptStatus: description: Captures the execution status of pre script. $ref: '#/components/schemas/ScriptExecutionStatus' restoreEntityVec: description: Contains the file paths and the information of the restored entities. type: - array - 'null' items: $ref: '#/components/schemas/RestoreInfoProto_RestoreEntity' x-go-name: RestoreEntityVec targetType: description: 'Specifies the target type for the task. The field is only valid if the task has got a permit.' type: - integer - 'null' format: int32 x-go-name: TargetType type: description: The type of environment this restore info pertains to. type: - integer - 'null' format: int32 x-go-name: Type x-go-package: magneto/base/magneto.pb RecoverVolumesTaskStateProto: type: object title: Persistent state for a "recover volumes" restore task. properties: params: description: Captures the original parameters from Iris. $ref: '#/components/schemas/RecoverVolumesParams' taskResultVec: description: 'Contains high-level per-volume information. This data is here because Iris cannot see into protobuf extensions yet needs to display per-subtask progress.' type: - array - 'null' items: $ref: '#/components/schemas/RecoverVolumesTaskStateProto_TaskResult' x-go-name: TaskResultVec x-go-package: magneto/master/base/master.pb RestoreOneDriveParams_DriveItem: description: This will be set in case of partial drive recovery. type: object title: Defining DriveItem proto-message. properties: driveItemPath: description: The path of the drive item relative to root. type: - string - 'null' x-go-name: DriveItemPath id: description: The unique identifier of the item within the Drive. type: - string - 'null' x-go-name: Id isFileItem: description: Specify if the item is a file or not. type: - boolean - 'null' x-go-name: IsFileItem x-go-package: magneto/base/magneto.pb RdsParams: description: Specifies rds params for the restore operation. type: object title: RDS parameters. required: - dbInstanceId properties: availabilityZoneId: description: Entity representing the availability zone to use while restoring the DB. type: - integer - 'null' format: int64 x-go-name: AvailabilityZoneId dbInstanceId: description: 'The DB instance identifier to use for the restored DB. This field is required.' type: - string - 'null' x-go-name: DbInstanceId dbOptionGroupId: description: Entity representing the RDS option group to use while restoring the DB. type: - integer - 'null' format: int64 x-go-name: DbOptionGroupId dbParameterGroupId: description: Entity representing the RDS parameter group to use while restoring the DB. type: - integer - 'null' format: int64 x-go-name: DbParameterGroupId dbPort: description: Port to use for the DB in the restored RDS instance. type: - integer - 'null' format: int32 x-go-name: DbPort enableAutoMinorVersionUpgrade: description: Whether to enable auto minor version upgrade in the restored DB. type: - boolean - 'null' x-go-name: EnableAutoMinorVersionUpgrade enableCopyTagsToSnapshots: description: Whether to enable copying of tags to snapshots of the DB. type: - boolean - 'null' x-go-name: EnableCopyTagsToSnapshots enableDbAuthentication: description: Whether to enable IAM authentication for the DB. type: - boolean - 'null' x-go-name: EnableDbAuthentication enablePublicAccessibility: description: Whether this DB will be publicly accessible or not. type: - boolean - 'null' x-go-name: EnablePublicAccessibility isMultiAzDeployment: description: Whether this is a multi-az deployment or not. type: - boolean - 'null' x-go-name: IsMultiAzDeployment x-go-package: cohesity/iris/server/data/public DSESolrInfo: type: object title: Message to hold information about DSE Solr node. properties: solrNodeVec: description: Solr node IP Addresses. type: - array - 'null' items: type: string x-go-name: SolrNodeVec solrPort: description: Solr node Port. type: - integer - 'null' format: uint32 x-go-name: SolrPort x-go-package: magneto/base/nosql.pb CloudDeployInfoProto_CloudDeployEntity: type: object properties: deployedVmName: description: Optional name that should be used for deployed VM. type: - string - 'null' x-go-name: DeployedVmName entity: description: The entity that was deployed to cloud. $ref: '#/components/schemas/EntityProto' error: description: 'If cloud deploy of the ''entity'' failed, this field may contain the cause of the failure.' $ref: '#/components/schemas/ErrorProto' previousRelativeCloneDirPath: description: 'Directory where files of the entity''s previous snapshot were cloned to. Path is relative to the destination view.' type: - string - 'null' x-go-name: PreviousRelativeCloneDirPath previousRelativeClonePaths: description: 'All the paths that the entity''s previous snapshot files were cloned to. Each path is relative to the destination view.' type: - array - 'null' items: type: string x-go-name: PreviousRelativeClonePaths progressMonitorTaskPath: description: 'Progress monitor task path for this entity which is relative to the root path of the cloud deploy task progress monitor.' type: - string - 'null' x-go-name: ProgressMonitorTaskPath publicStatus: description: Iris-facing task state. This field is stamped during the export. type: - integer - 'null' format: int32 x-go-name: PublicStatus relativeClonePaths: description: 'All the paths that the entity''s files were cloned to. Each path is relative to the destination view.' type: - array - 'null' items: type: string x-go-name: RelativeClonePaths status: description: The status of the entity. type: - integer - 'null' format: int32 x-go-name: Status x-go-package: magneto/base/magneto.pb S3ViewBackupProperties: description: // ----------------------------------------------------------------------------- type: object properties: accessKey: description: 'Access key for the buckets which will be created for the source initiated jobs. This needs to be passed to Netapp for it to for doing all s3 communications.' type: - string - 'null' x-go-name: AccessKey s3Config: description: 'For source initiated backup the target is s3 view. This captures the configuration needed to create the s3 view.' $ref: '#/components/schemas/S3BucketConfigProto' secretKey: description: 'Secret key for the buckets will be created for the source initiated jobs. This secret key needed to be sent to Netapp for writing data to our S3 views.' type: - string - 'null' x-go-name: SecretKey snapshotPrefixName: description: 'The snapshot prefix which is needed at the time of incremental for backups. This is only needed for case of DP volume.' type: - string - 'null' x-go-name: SnapshotPrefixName viewId: description: The id of the S3 view. type: - integer - 'null' format: int64 x-go-name: ViewId x-go-package: magneto/base/env_params.pb RestoredObjectVCDConfigProto: type: object properties: isVapp: description: Whether the restored object is a VApp. type: - boolean - 'null' x-go-name: IsVapp isVappTemplate: description: Whether the restored object is a VApp template. type: - boolean - 'null' x-go-name: IsVappTemplate restoredVappInfo: description: 'Entity info enabled only when is_vapp is true. This proto will contain the original vApp that is protected.' $ref: '#/components/schemas/EntityProto' restoredVappTemplateInfo: description: 'Entity info enabled only when is_vapp_template is true. This proto will contain the original vApp template that is protected.' $ref: '#/components/schemas/EntityProto' vappEntity: description: 'Entity info of the vApp to be used to import the VMs into while performing recovery of VMs into exisintg vApps.' $ref: '#/components/schemas/EntityProto' vcenterConnectorParams: description: 'Connector params associated with the vcenter which will be captured for vCD environment.' $ref: '#/components/schemas/ConnectorParams' vdcEntity: description: Entity info of the Virtual Datacenter used while composing a new vApp. $ref: '#/components/schemas/EntityProto' x-go-package: magneto/master/base/master.pb ADObjectRestoreParam: type: object title: Restore AD objects from recycle bin or from a mounted AD snapshot database. properties: credentials: description: 'For restoring user type objects (user, inetOrgPerson or organizationalPerson LDAP classes) that is returned in search result with ''kRestorePasswordRequired'' flag, an initial password is required. The password is UTF8 string encoded. Password cannot be empty and must satisfy production AD password complexity. If ''kFromDestRecycleBinIfFound'' is true and the user is restored from production AD recycle bin, password will not be changed and the restored user retains their original password. For non-user type objects, this password value is ignored. The username field is ignored in the credentials.' $ref: '#/components/schemas/Credentials' guidVec: description: 'Array of AD object guids to restore either from recycle bin or from AD snapshot. The guid should not exist in production AD. If it exits, then kDuplicate error is output in status.' type: - array - 'null' items: type: string x-go-name: GuidVec optionFlags: description: Restore option flags of type ADObjectRestoreOptionFlags. type: - integer - 'null' format: uint32 x-go-name: OptionFlags ouPath: description: 'Distinguished name(DN) of the target Organization Unit (OU) to restore non-OU object. This can be empty, in which case objects are restored to their original OU. The ''credential'' specified must have privileges to add objects to this OU. Example: ''OU=SJC,OU=EngOU,DC=contoso,DC=com''. This parameter is ignored for OU objects.' type: - string - 'null' x-go-name: OuPath srcSysvolFolder: description: When restoring a GPO, need to know the absolute path for SYSVOL folder. type: - string - 'null' x-go-name: SrcSysvolFolder x-go-package: magneto/agents/windows/stub/ad_param.pb RetrieveArchiveInfo_RetrievedEntity: description: 'Proto to define the info about the entity that was retrieved from an archive.' type: object properties: bytesTransferred: description: Number of physical bytes transferred over wire for this entity. type: - integer - 'null' format: int64 x-go-name: BytesTransferred endTimestampUsecs: description: Time in microseconds when retrieve of this entity finished or failed. type: - integer - 'null' format: int64 x-go-name: EndTimestampUsecs entity: description: The entity that was retrieved. $ref: '#/components/schemas/EntityProto' error: description: 'If the retrieve of the ''entity'' failed, this field may contain the cause of the failure.' $ref: '#/components/schemas/ErrorProto' logicalBytesTransferred: description: Number of logical bytes transferred so far. type: - integer - 'null' format: int64 x-go-name: LogicalBytesTransferred logicalSizeBytes: description: Total logical size of this entity. type: - integer - 'null' format: int64 x-go-name: LogicalSizeBytes progressMonitorTaskPath: description: 'The path relative to the root path of the retrieval task progress monitor of this entity progress monitor.' type: - string - 'null' x-go-name: ProgressMonitorTaskPath relativeSnapshotDir: description: 'The path relative to the root of the file system where the snapshot of this entity was retrieved/copied to.' type: - string - 'null' x-go-name: RelativeSnapshotDir startTimestampUsecs: description: Time in microseconds when retrieve of this entity started. type: - integer - 'null' format: int64 x-go-name: StartTimestampUsecs status: description: The retrieval status of this entity. type: - integer - 'null' format: int32 x-go-name: Status x-go-package: magneto/master/base/master.pb HiveConnectParams: description: 'Specifies an Object containing information about a registered Hive source.' type: object title: Hive Connect Params. properties: hdfsEntityId: description: Specifies the entity id of the HDFS source for this Hive type: - integer - 'null' format: int64 x-go-name: HdfsEntityId kerberosPrincipal: description: Specifies the kerberos principal. type: - string - 'null' x-go-name: KerberosPrincipal metastore: description: Specifies the Hive metastore host. type: - string - 'null' x-go-name: Metastore thriftPort: description: Specifies the Hive metastore thrift Port type: - integer - 'null' format: int32 x-go-name: ThriftPort x-go-package: cohesity/iris/server/data/public RestoreAppObject: description: 'Message that captures information about an application object being restored.' type: object properties: additionalParams: description: Any additional parameters associated with a restore task. $ref: '#/components/schemas/RestoreTaskAdditionalParams' appEntity: description: 'The application entity to restore (for example, kSQL, kOracle). If this is not set, all the apps in the owning entity will be restored.' $ref: '#/components/schemas/EntityProto' displayName: description: 'The proper display name of this object in the UI, if app_entity is not empty. For example, for SQL databases the name should also include the instance name.' type: - string - 'null' x-go-name: DisplayName restoreParams: description: The restore params for the RestoreAppObject. $ref: '#/components/schemas/RestoreAppObjectParams' x-go-package: magneto/base/magneto.pb RestoreOracleAppObjectParams_KeyValuePair: description: This defines the restore Shell environment. type: object title: A table of key-value pair representing Shell variables and their values. properties: xKey: description: Name of the key. type: - string - 'null' x-go-name: XKey xValue: description: Value of the key. type: - string - 'null' x-go-name: XValue x-go-package: magneto/base/magneto.pb RestoreFileCopyStats: description: 'This message captures the progress information regarding restore of file/directory.' type: object properties: estimationSkipped: description: 'This will be set to true if the estimation step was skipped. NOTE: If estimation is skipped, then progress info will not be available.' type: - boolean - 'null' x-go-name: EstimationSkipped numBytesCopied: description: Number of bytes copied so far. type: - integer - 'null' format: int64 x-go-name: NumBytesCopied numDirectoriesCopied: description: 'Number of directories copied so far. NOTE: This just means the creation of directory (not the contents of the directory).' type: - integer - 'null' format: int32 x-go-name: NumDirectoriesCopied numFilesCopied: description: Number of files copied so far. type: - integer - 'null' format: int32 x-go-name: NumFilesCopied totalBytesToCopy: description: Total number of bytes to copy. type: - integer - 'null' format: int64 x-go-name: TotalBytesToCopy totalDirectoriesToCopy: description: 'Total number of directories to copy. NOTE: This just means the creation of directory (not the contents of the directory).' type: - integer - 'null' format: int32 x-go-name: TotalDirectoriesToCopy totalFilesToCopy: description: Total number of files to copy. type: - integer - 'null' format: int32 x-go-name: TotalFilesToCopy x-go-package: magneto/base/magneto.pb ADUpdateRestoreTaskOptions: type: object title: AD specific options to update an AD restore task. properties: objectAttributesParam: description: 'Object attributes restore params with the list of attributes to be restored. This is set only when type is kObjectAttributes.' $ref: '#/components/schemas/ADAttributeRestoreParam' objectParam: description: 'Object restore params with info about objects to be restored. This is set only when type is kObjects.' $ref: '#/components/schemas/ADObjectRestoreParam' type: description: Specifies the AD restore request type. type: - integer - 'null' format: int32 x-go-name: Type x-go-package: magneto/base/magneto.pb ClusterIdentifier: type: object title: ClusterIdentifier uniquely identifies a cluster. properties: clusterId: description: Specifies the cluster id of the cluster. type: - integer - 'null' format: int64 x-go-name: ClusterId clusterIncarnationId: description: Specifies the cluster incarnation id. type: - integer - 'null' format: int64 x-go-name: ClusterIncarnationId x-go-package: cohesity/iris/server/data/public NodeToTieredStorageDirectoriesMap: type: object title: Mapping of each Cassandra node to a list of tiered storage directories. properties: cassandraNodeName: description: Name of the Cassandra node. type: - string - 'null' x-go-name: CassandraNodeName tieredStorageDirectoriesVec: description: Array of tiered storage directories. type: - array - 'null' items: type: string x-go-name: TieredStorageDirectoriesVec x-go-package: magneto/base/nosql.pb RestoreWrapperProto: description: 'If this message is a checkpoint record in WAL-logging or if this message is used to send restore task info back to the user, it will contain the info of the restore job/task and the list of all destroy tasks (only when the record is for a restore task of type clone) associated with it. If this message is delta record, it will contain the state mutation for one of individual restore job, restore task and individual destroy task.' type: object title: 'A wrapper proto to put together all the restore-related protos. This will be used for WAL-logging, and to send restore-related information back to the user.' properties: destroyClonedTaskStateVec: description: 'For a restore task of type ''Clone'', this field contains the info of the destroy task(s).' type: - array - 'null' items: $ref: '#/components/schemas/DestroyClonedTaskStateProto' x-go-name: DestroyClonedTaskStateVec ownerRestoreWrapperProto: description: 'Note that this field is only populated for Iris in response to ''GetRestoreTasksArg'' RPC.' title: 'For an application restore task, this field contains the info of the application owner''s restore task if any. For example, a SQL restore operation may also restore its owner VM, and this field will contain the VM''s restore task.' $ref: '#/components/schemas/RestoreWrapperProto' performRefreshTaskStateVec: description: Contains information of the refresh tasks for a clone type: - array - 'null' items: $ref: '#/components/schemas/PerformRestoreTaskStateProto' x-go-name: PerformRefreshTaskStateVec performRestoreJobState: description: 'Contains the information about a restore job. When the info of the restore job is send to the Iris, we will transform this proto to the above ''perform_restore_task_state'' so that Iris has to deal with only one kind of restore proto.' $ref: '#/components/schemas/PerformRestoreJobStateProto' performRestoreTaskState: description: Contains information about a restore task. $ref: '#/components/schemas/PerformRestoreTaskStateProto' restoreSubTaskWrapperProtoVec: description: 'If this restore has sub tasks, the following field will get populated with the wrapper proto of all of its sub-tasks. Note that this field is only populated for Iris in response to ''GetRestoreTasksArg'' RPC. It is not persisted in Magneto''s WAL. List of environments that use this field: kSQL : Used for multi-stage SQL restore that supports a hot-standy.' type: - array - 'null' items: description: 'If this message is a checkpoint record in WAL-logging or if this message is used to send restore task info back to the user, it will contain the info of the restore job/task and the list of all destroy tasks (only when the record is for a restore task of type clone) associated with it. If this message is delta record, it will contain the state mutation for one of individual restore job, restore task and individual destroy task.' type: object title: 'A wrapper proto to put together all the restore-related protos. This will be used for WAL-logging, and to send restore-related information back to the user. (RestoreWrapperProto)' x-go-name: RestoreSubTaskWrapperProtoVec x-go-package: magneto/master/base/master.pb ErrorProto: type: object properties: errorMsg: description: An optional detail. type: - string - 'null' x-go-name: ErrorMsg type: description: Error. type: - integer - 'null' format: int32 x-go-name: Type x-go-package: yoda/base/error.pb CouchbaseConnectParams: description: 'Specifies an Object containing information about a registered couchbase source.' type: object title: Couchbase Connect Params. properties: carrierDirectPort: description: Specifies the Carrier direct/sll port. type: - integer - 'null' format: int32 x-go-name: CarrierDirectPort httpDirectPort: description: Specifies the HTTP direct/sll port. type: - integer - 'null' format: int32 x-go-name: HttpDirectPort requiresSsl: description: Specifies whether this cluster allows connection through SSL only. type: - boolean - 'null' x-go-name: RequiresSsl seeds: description: Specifies the Seeds of this Couchbase Cluster. type: - array - 'null' items: type: string x-go-name: Seeds x-go-package: cohesity/iris/server/data/public VirtualDiskId: description: 'This message defines the proto that can be used to identify the disks in different environments.' type: object properties: controllerBusNumber: description: Controller's bus-id controlling the virtual disk in question. type: - integer - 'null' format: int64 x-go-name: ControllerBusNumber controllerType: description: Controller's type (SCSI, IDE etc). type: - string - 'null' x-go-name: ControllerType diskId: description: 'Original disk id. This is sufficient to identify the disk information, but in some scenarios, user''s may specify the controller option instead.' type: - string - 'null' x-go-name: DiskId unitNumber: description: Disk unit number to identify the virtual disk within a controller. type: - integer - 'null' format: int64 x-go-name: UnitNumber x-go-package: magneto/base/magneto.pb DeployFleetParams: type: object title: Contains Fleet specific params. properties: awsFleetParams: description: Contains AWS Fleet specific params. $ref: '#/components/schemas/AWSFleetParams' x-go-package: magneto/base/cloud_deploy.pb CompareADObjectsResult_ADAttributeValue: type: object title: Represents an AD attribute value in string format. properties: valueFlags: description: Object result flags of type ADAttributeValueFlags. type: - integer - 'null' format: uint32 x-go-name: ValueFlags valueVec: description: 'String representation of attribute value. For single valued property, only one value will be present here. For multi-valued properties such as group membership, this field will contain values that are in same order as contained in AD. Each AD attribute value will be converted to string. If this property is not set, then the property has null value.' type: - array - 'null' items: type: string x-go-name: ValueVec x-go-package: magneto/agents/windows/stub/ad_param.pb ScriptExecutionStatus: type: object title: Message to encapsulate the status of a script. properties: error: description: Error that occurred during execution. $ref: '#/components/schemas/ErrorProto' executing: description: 'Indicates if a script is executing. This is particularly useful when there is a cancellation request and Magneto crashes at that point before cleaning up the running script.' type: - boolean - 'null' x-go-name: Executing exitCode: description: Exit code of the script. type: - integer - 'null' format: int32 x-go-name: ExitCode state: description: Execution state of the script. type: - integer - 'null' format: int32 x-go-name: State x-go-package: magneto/base/magneto.pb CommonACLProto_Grantees: type: object properties: allUsers: description: This field indicates if all users are granted ACL permission. type: - boolean - 'null' x-go-name: AllUsers deniedReferrerVec: description: This field holds a list of referers who are denied ACL permission. type: - array - 'null' items: type: string x-go-name: DeniedReferrerVec grantedReferrerVec: description: This field holds a list of referers who are granted ACL permission. type: - array - 'null' items: type: string x-go-name: GrantedReferrerVec rlistings: description: 'This fields indicates if container GET and HEAD operations are permitted provided that read access is granted (using referer ACL) on objects.' type: - boolean - 'null' x-go-name: Rlistings x-go-package: bridge/s3_portal/base/s3_metadata.pb OracleSourceParams: description: Message to capture additional backup/restore params for a Oracle source. type: object title: Oracle Source Parameters. properties: additionalOracleDbParamsVec: description: 'A vector of unique Oracle databases. Each vector entry represents the backup/restore parameters for one unique Oracle database. Uniqueness is determined by the database unique name.' type: - array - 'null' items: $ref: '#/components/schemas/AdditionalOracleDBParams' x-go-name: AdditionalOracleDbParamsVec persistMountpoints: description: 'This parameter indicates whether or not to persist mountpoints. Default is set to true, which was the behavior before this option.' type: - boolean - 'null' x-go-name: PersistMountpoints x-go-package: magneto/base/env_params.pb RestoreObjectDetails: description: 'Specifies an object to recover or clone or an object to restore files and folders from. A VM object can be recovered or cloned. A View object can be cloned. To specify a particular snapshot, you must specify a jobRunId and a startTimeUsecs. If jobRunId and startTimeUsecs are not specified, the last Job Run of the specified Job is used.' type: object title: Restore Object. properties: archivalTarget: description: 'Specifies settings about the Archival Target (such as Tape or AWS). This field must be set if the object is being recovered or cloned from an archive or if files or folders are being restored from an archive.' title: Archival Target. allOf: - $ref: '#/components/schemas/ArchivalExternalTarget' cloudDeployTarget: description: 'Specifies settings about the Cloud Deploy target. This field must be set if the restore type is kDeployVMs and the object is to be deployed to cloud using a previously converted image.' title: CloudDeploy Target. allOf: - $ref: '#/components/schemas/CloudDeployTargetDetails' environment: description: 'Specifies the type of the Protection Source. Supported environment types such as ''kView'', ''kSQL'', ''kVMware'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter. ''kVMware'' indicates the VMware Protection Source environment. ''kHyperV'' indicates the HyperV Protection Source environment. ''kSQL'' indicates the SQL Protection Source environment. ''kView'' indicates the View Protection Source environment. ''kPuppeteer'' indicates the Cohesity''s Remote Adapter. ''kPhysical'' indicates the physical Protection Source environment. ''kPure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''kAzure'' indicates the Microsoft''s Azure Protection Source environment. ''kNetapp'' indicates the Netapp Protection Source environment. ''kAgent'' indicates the Agent Protection Source environment. ''kGenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''kAcropolis'' indicates the Acropolis Protection Source environment. ''kPhsicalFiles'' indicates the Physical Files Protection Source environment. ''kIsilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''kGPFS'' indicates IBM''s GPFS Protection Source environment. ''kKVM'' indicates the KVM Protection Source environment. ''kAWS'' indicates the AWS Protection Source environment. ''kExchange'' indicates the Exchange Protection Source environment. ''kHyperVVSS'' indicates the HyperV VSS Protection Source environment. ''kOracle'' indicates the Oracle Protection Source environment. ''kGCP'' indicates the Google Cloud Platform Protection Source environment. ''kFlashBlade'' indicates the Flash Blade Protection Source environment. ''kAWSNative'' indicates the AWS Native Protection Source environment. ''kO365'' indicates the Office 365 Protection Source environment. ''kO365Outlook'' indicates Office 365 outlook Protection Source environment. ''kHyperFlex'' indicates the Hyper Flex Protection Source environment. ''kGCPNative'' indicates the GCP Native Protection Source environment. ''kAzureNative'' indicates the Azure Native Protection Source environment. ''kKubernetes'' indicates a Kubernetes Protection Source environment. ''kElastifile'' indicates Elastifile Protection Source environment. ''kAD'' indicates Active Directory Protection Source environment. ''kRDSSnapshotManager'' indicates AWS RDS Protection Source environment. ''kCassandra'' indicates Cassandra Protection Source environment. ''kMongoDB'' indicates MongoDB Protection Source environment. ''kCouchbase'' indicates Couchbase Protection Source environment. ''kHdfs'' indicates Hdfs Protection Source environment. ''kHive'' indicates Hive Protection Source environment. ''kHBase'' indicates HBase Protection Source environment.' type: - string - 'null' enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kNimble - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kAzureNative - kKubernetes - kElastifile - kAD - kRDSSnapshotManager - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase x-go-name: Environment jobId: description: 'Protection Job Id. Specifies id of the Protection Job that backed up the objects to be restored.' type: - integer - 'null' format: int64 x-go-name: JobId jobRunId: description: Specifies the id of the Job Run that captured the snapshot. type: - integer - 'null' format: int64 x-go-name: JobRunId jobUid: description: 'Specifies the universal id of the Protection Job that backed up the objects to recover or clone or the objects that contain the files or folders to recover.' title: Universal Id. allOf: - $ref: '#/components/schemas/UniversalId' protectionSourceId: description: 'Specifies the id of the leaf object to recover, clone or recover files/folders from.' type: - integer - 'null' format: int64 x-go-name: ProtectionSourceId sourceName: description: Specifies the name of the Protection Source. type: - string - 'null' x-go-name: SourceName startedTimeUsecs: description: 'Specifies the time when the Job Run starts capturing a snapshot. Specified as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: StartedTimeUsecs x-go-package: cohesity/iris/server/data/public KeyValuePair: description: Specifies a key/value pair. type: object title: Key Value Pair. properties: key: description: Specifies the name of the key. type: - string - 'null' x-go-name: Key value: description: Specifies a value for the key. $ref: '#/components/schemas/Value' x-go-package: stats/base/stats_types.pb AdditionalOracleDBParams: type: object title: Message to capture additional channel information for Oracle Database. properties: appEntityId: description: Database app id. type: - integer - 'null' format: int64 x-go-name: AppEntityId dbInfoChannelVec: description: 'The following proto message should be renamed to a more general message to represent parameters pertaining to a single unique Oracle database. Uniqueness of an Oracle database should be strictly determined by its database unique name. i.e. all backup parameters needed for a unique Oracle database should be expressed in the following proto. It is a vector for future support of backing up Data Guard sources. We may or may not need this to be vector to support Data Guard sources. For now, the size of this vector is always 1. When we rename this proto in the future, if we determine there is no need to use a vector for Data Guard support, we can choose to remove ''repeated''.' type: - array - 'null' items: $ref: '#/components/schemas/OracleDBChannelInfo' x-go-name: DbInfoChannelVec x-go-package: magneto/base/env_params.pb ClusterConfigProto_SID: description: 'Represents the security identifier that uniquely defines a security principal. SIDs are associated with users and groups. Reference: https://msdn.microsoft.com/en-us/library/aa379597.aspx' type: object properties: identifierAuthority: description: 'The authority under which the SID was created. This is always 6 bytes long.' type: - array - 'null' items: type: integer format: uint8 x-go-name: IdentifierAuthority revisionLevel: description: The revision level of the SID. type: - integer - 'null' format: int32 x-go-name: RevisionLevel subAuthority: description: 'List of ids relative to the identifier_authority that uniquely identify a principal. The last entry in this list is the RID, which uniquely identifies the principal within a domain.' type: - array - 'null' items: type: integer format: uint32 x-go-name: SubAuthority x-go-package: configs/cluster_config.pb MORef: type: object title: Type that represents the ManagedObjectReference in VMware. properties: item: type: - string - 'null' x-go-name: Item type: type: - string - 'null' x-go-name: Type x-go-package: magneto/base/entities/vmware_common.pb RestoreO365PublicFoldersParams: type: object title: This message defines the O365 Public Folders specific restore params. properties: rootPublicFolderVec: description: 'In a RestoreJob , user will provide the list of Root Public Folders to be restored. Provision is there for restoring full and partial Public Folder recovery.' type: - array - 'null' items: $ref: '#/components/schemas/RestoreO365PublicFoldersParams_RootPublicFolder' x-go-name: RootPublicFolderVec targetFolderPath: type: - string - 'null' x-go-name: TargetFolderPath targetRootPublicFolder: description: 'All RootPublicFolders listed in the root_public_folder_vec will be restored to this traget RootPublicFolder with appropriate names. Let''s say root_public_folder_vec is A and B; target_root_public_folder is C. The final folder-hierarchy after restore job is finished will look like this C/{target_folder_path}/A/{whatever is there in Public Folder A} B/{whatever is inside Public Folder B}' title: This is the target Public Folder. $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/magneto.pb AWSFleetParams: type: object title: Params for AWS fleets deployment. properties: fleetSubnetType: description: 'Fleet''s subnet type. This field should always be set when specifying fleet params.' type: - integer - 'null' format: int32 x-go-name: FleetSubnetType fleetTagVec: description: Optional list of tags to be associated with the fleets. type: - array - 'null' items: $ref: '#/components/schemas/AWSFleetParams_Tag' x-go-name: FleetTagVec networkParams: description: 'Network information for the fleet. This will be only set when fleet_subnet_type is kCustom.' $ref: '#/components/schemas/AWSFleetParams_NetworkParams' networkParamsMap: description: 'Map for a region to network params, as network params can be defined per region. Only set when kCustom fleet subnet type is being used.' type: - array - 'null' items: $ref: '#/components/schemas/AWSFleetParams_NetworkParamsMapEntry' x-go-name: NetworkParamsMap networkParamsVec: description: 'Network information for the fleet. This will be only set when fleet_subnet_type is kCustom.' type: - array - 'null' items: $ref: '#/components/schemas/AWSFleetParams_NetworkParams' x-go-name: NetworkParamsVec x-go-package: magneto/base/entities/aws.pb TenantConfig: description: Specifies struct with basic tenant specific configuration. type: object title: Tenant Config. properties: name: description: Specifies name of the tenant. type: - string - 'null' x-go-name: Name restricted: description: 'Whether the user is a restricted user. A restricted user can only view the objects he has permissions to.' type: - boolean - 'null' x-go-name: Restricted roles: description: 'Array of Roles. Specifies the Cohesity roles to associate with the user such as such as ''Admin'', ''Ops'' or ''View''. The Cohesity roles determine privileges on the Cohesity Cluster for this user.' type: - array - 'null' items: type: string x-go-name: Roles tenantId: description: Specifies the unique id of the tenant. type: - string - 'null' x-go-name: TenantId x-go-package: cohesity/iris/server/data/public RestoreAppParams: description: 'This message captures all the necessary arguments specified by the user to restore an application.' type: object properties: credentials: description: 'For a local restore operation, credentials are optional. If not specified, the restore operation will use the credentials that were used to register the application''s owner entity. For a remote restore operation from a replicated target, credentials must be specified.' title: Credentials that will be used to log into the application environment. $ref: '#/components/schemas/Credentials' ownerRestoreInfo: description: The restore information about the application's owner. $ref: '#/components/schemas/AppOwnerRestoreInfo' restoreAppObjectVec: description: 'The application level objects that needs to be restored. If this vector is populated with exactly one object without its ''app_entity'', all the application objects of the owner will be restored. If multiple objects are being restored, the ''app_entity'' field must be specified for all of them.' type: - array - 'null' items: $ref: '#/components/schemas/RestoreAppObject' x-go-name: RestoreAppObjectVec type: description: The application environment. type: - integer - 'null' format: int32 x-go-name: Type x-go-package: magneto/base/magneto.pb DestroyClonedTaskStateProto: type: object properties: actionExecutorTargetType: description: 'Denotes the target for action executor(Bridge/Bridge_Proxy) on which task on slave should execute actions.' type: - integer - 'null' format: int32 x-go-name: ActionExecutorTargetType cloneTaskName: description: The name of the clone task. type: - string - 'null' x-go-name: CloneTaskName datastoreEntity: description: 'The EntityProto of the datastore that corresponds to the above ''view_name''. This field will be empty if no datastore is associated with the clone view.' $ref: '#/components/schemas/EntityProto' deployVmsToCloudTaskState: description: 'Master populates information regarding deploy vm to cloud task state. This is needed during restore task of type kConvertAndDeployVMs. We use it during destroy clone to delete VMs, network entities and storage blobs.' title: 'The following field is only relevant for a destroy for task of type kConvertAndDeployVMs.' $ref: '#/components/schemas/DeployVMsToCloudTaskStateProto' destroyCloneAppTaskInfo: description: 'Master populates the information about the destroy clone application task. Slave populates the progress and status of the task.' $ref: '#/components/schemas/DestroyCloneAppTaskInfoProto' destroyCloneVmTaskInfo: description: 'Master populates the information about the destroy clone task. Slave populates the progress and status of the task.' $ref: '#/components/schemas/DestroyClonedVMTaskInfoProto' destroyMountVolumesTaskInfo: description: 'Master populates the information about the destroy mount volumes task, Slave populate the progress and status of the task.' $ref: '#/components/schemas/DestroyMountVolumesTaskInfoProto' endTimeUsecs: description: 'If the destroy clone task has finished, this field contains the end time of the task.' type: - integer - 'null' format: int64 x-go-name: EndTimeUsecs error: description: 'The error encountered by task (if any). Only valid if the task has finished.' $ref: '#/components/schemas/ErrorProto' folderEntity: description: 'A folder entity where the cloned objects are placed. This folder will be deleted after all cloned entity are destroyed.' $ref: '#/components/schemas/EntityProto' forceDelete: description: flag used to perform force delete, ignore error on delete steps type: - boolean - 'null' x-go-name: ForceDelete fullViewName: description: The full external view name where cloned objects are placed. type: - string - 'null' x-go-name: FullViewName parentSourceConnectionParams: description: 'Note: In case of kConvertAndDeployVMs to Azure, we need the original ConnectorParams of the corresponding deploy to Azure task (i.e. original Azure subscription id).' title: 'A way to connect to the parent source. We do not use the connection param info of the corresponding clone task as it might have changed.' $ref: '#/components/schemas/ConnectorParams' parentTaskId: description: 'The id of the task that triggered the destroy task. This will be used by refresh task to mark the destroy task as internal sub-task.' type: - integer - 'null' format: int64 x-go-name: ParentTaskId performCloneTaskId: description: The unique id of the task that performed the clone operation. type: - integer - 'null' format: int64 x-go-name: PerformCloneTaskId restoreType: description: The type of the restore/clone operation that is being destroyed. type: - integer - 'null' format: int32 x-go-name: RestoreType scheduledConstituentId: description: 'Constituent id (and the gandalf session id) where this task has been scheduled. If -1, the task is not running at any slave. It''s possible that the task was previously scheduled, but is now being re-scheduled.' type: - integer - 'null' format: int64 x-go-name: ScheduledConstituentId scheduledGandalfSessionId: type: - integer - 'null' format: int64 x-go-name: ScheduledGandalfSessionId startTimeUsecs: description: The start time of this destroy clone task. type: - integer - 'null' format: int64 x-go-name: StartTimeUsecs status: description: Status of the destroy clone task. type: - integer - 'null' format: int32 x-go-name: Status taskId: description: A globally unique id of this destroy clone task. type: - integer - 'null' format: int64 x-go-name: TaskId type: description: The type of environment that is being operated on. type: - integer - 'null' format: int32 x-go-name: Type user: description: The user who requested this destroy clone task. type: - string - 'null' x-go-name: User userInfo: description: Specifies information about the user who made the request. $ref: '#/components/schemas/UserInformation' vcdConfig: description: VCD config for the restored object. $ref: '#/components/schemas/RestoredObjectVCDConfigProto' viewBoxId: description: The view box id to which 'view_name' belongs to. type: - integer - 'null' format: int64 x-go-name: ViewBoxId viewName_DEPRECATED: description: The view name as provided by the user for the clone operation. type: - string - 'null' x-go-name: ViewName_DEPRECATED x-go-package: magneto/master/base/master.pb RenameObjectParamProto: description: 'Message to specify the prefix/suffix added to rename an object. At least one of prefix or suffix must be specified. Please note that both prefix and suffix can be specified.' type: object properties: prefix: description: Prefix to be added to a name. type: - string - 'null' x-go-name: Prefix suffix: description: Suffix to be added to a name. type: - string - 'null' x-go-name: Suffix x-go-package: magneto/base/magneto.pb Domain: type: object title: Keystone domain proto. properties: description: type: - string - 'null' x-go-name: Description enabled: type: - boolean - 'null' x-go-name: Enabled id: type: - string - 'null' x-go-name: Id links: description: Links to the domain resource. $ref: '#/components/schemas/Links' name: type: - string - 'null' x-go-name: Name x-go-package: bridge/s3_portal/keystone/keystone2.pb OracleDBChannelInfo: description: 'Note: The name of this proto message is out-dated. This proto can represent more than just the database channel information. It should be renamed in the future.' type: object title: 'Message to contain backup or restore parameters for a unique Oracle database. The Oracle database unique name is used to determine uniqueness of the database.' properties: archivelogKeepDays: description: 'Archived log deletion policy for this unique Oracle database. 1: keep archived log forever 0: delete archived log immediately n>0: delete archived log after n days' type: - integer - 'null' format: int32 x-go-name: ArchivelogKeepDays dbUniqueName: description: The unique name of the database. type: - string - 'null' x-go-name: DbUniqueName dbUuid: description: 'Database id, internal field, is filled by magneto master based on corresponding app entity id.' type: - string - 'null' x-go-name: DbUuid enableDgPrimaryBackup: description: 'If set to false, and if the DG database role is primary, we will not allow the backup of that database.' type: - boolean - 'null' x-go-name: EnableDgPrimaryBackup hostInfoVec: description: 'Vector of Oracle hosts from which we are allowed to take the backup/restore. In case of RAC database it may be more than one.' type: - array - 'null' items: $ref: '#/components/schemas/OracleDBChannelInfo_HostInfo' x-go-name: HostInfoVec maxNumHost: description: 'Maximum number of hosts from which we are allowed to take backup/restore parallely. This will be less than or equal to host_info_vec_size. If this is less than host_info_vec_size we will choose max_num_host from host_info_vec and take backup/restore from this number of host.' type: - integer - 'null' format: int32 x-go-name: MaxNumHost numChannels: description: 'The default number of channels to use per host per db. This value is used on all hosts unless host_info_vec.num_channels is specified for that host. Default value for num_channels will be calculated as minimum number of nodes in cohesity cluster, and 2 * number of cpu on Oracle host. Preference order for number of channels per host for given db is: 1. If user has specified host_info_vec.num_channels for host we will use that. 2. If user has not specified host_info_vec.num_channels but specified num_channels we will use this. 3. If user has neither specified host_info_vec.num_channels nor num_channels we will calculate default channels with above formula.' type: - integer - 'null' format: int32 x-go-name: NumChannels rmanBackupType: description: Type of Oracle RMAN backup rquested (i.e ImageCopy, BackupSets). type: - integer - 'null' format: int32 x-go-name: RmanBackupType x-go-package: magneto/base/env_params.pb RestoreKubernetesNamespacesParams: type: object title: This message defines the Kubernetes specific namespace restore params. properties: backupJobName: description: Backup job that needs to be used for recovering the namespace. type: - string - 'null' x-go-name: BackupJobName clusterEntity: description: 'This field is optional for a kRecoverNamespaces task if the namespace is being restored to its original parent source. If not specified, restored namespace will be attached to its original cluster. This field is mandatory if the namespace is being restored to a different parent source.' $ref: '#/components/schemas/EntityProto' managementNamespace: description: Namespace in which restore job will be created in K8s cluster. type: - string - 'null' x-go-name: ManagementNamespace renameRestoredObjectParam: description: 'By default, namespaces are restored with their original name. This field can be used to specify the transformation ( i.e prefix/suffix) to be applied to the source namespace to derive the new name of the restored namespace.' $ref: '#/components/schemas/RenameObjectParamProto' x-go-package: magneto/base/magneto.pb AdditionalConnectorParams: description: 'Message that encapsulates the additional connector params to establish a connection with a particular environment.' type: object properties: o365Region: description: 'Optional o365_region proto to store the region info to be used while making ews/graph api calls in o365 adapter.' $ref: '#/components/schemas/O365RegionProto' useOutlookEwsOauth: description: 'Whether OAuth should be used for authentication with EWS API (outlook backup), applicable only for Exchange Online.' type: - boolean - 'null' x-go-name: UseOutlookEwsOauth x-go-package: magneto/base/magneto.pb LifecycleConfigProto: description: 'Protobuf that describes the lifecycle configuration that is used to manage the lifecycle of objects in a bucket.' type: object x-go-package: bridge/s3_portal/base/s3_metadata.pb RestoreTaskWrapper: type: object title: RestoreTaskWrapper defines the struct for a restore operation. properties: restoreTask: description: 'RestoreTask is the struct for RestoreWrapperProto used by magneto. It wraps either a Restore/Clone task, or a Destroy clone task.' $ref: '#/components/schemas/RestoreWrapperProto' x-go-package: cohesity/iris/server/data/public ReplicateSnapshotsToAWSParams: description: 'Params required to replicate snapshots to another AWS source. This is populated for AWS snapshot manager replication.' type: object properties: region: description: Name of the AWS region in which to replicate the snapshots. $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/cloud_deploy.pb RestoreAcropolisVMParam_NetworkConfigInfo: description: 'Proto to define the network configuration to be applied to the restored VM.' type: object properties: networkStateChange: description: Network state to be applied to the restored VM. type: - integer - 'null' format: int32 x-go-name: NetworkStateChange nicVec: description: 'This field is applicable only if the network_state_change is set to ''kAttachNewNetwork''.' type: - array - 'null' items: $ref: '#/components/schemas/RestoreAcropolisVMParam_NetworkConfigInfo_NICSpec' x-go-name: NicVec x-go-package: magneto/base/magneto.pb MongoDBRecoverJobParams: description: 'Contains any additional mongodb environment specific params for the recover job.' type: object properties: suffix: description: A suffix that is to be applied to all recovered entities type: - string - 'null' x-go-name: Suffix x-go-package: magneto/base/nosql.pb ADObjectRestoreStatus_ADAttributeRestoreStatus: type: object title: AD attribute (property) restore status for a specific property. properties: attrstatusVec: description: 'Error status. If the ''attrstatus_vec'' is empty or contains kNoError, treat the attribute restore as success. For multi-valued properties such as ''memberOf'', this vector may contain failure to add or remove specific value within the multi-value set.' type: - array - 'null' items: $ref: '#/components/schemas/ErrorProto' x-go-name: AttrstatusVec ldapName: description: LDAP name of the attribute. type: - string - 'null' x-go-name: LdapName x-go-package: magneto/agents/windows/stub/ad_param.pb RestoreExchangeParams_DatabaseOptions: type: object properties: entityId: description: The windows machine to which the database will be restored. type: - integer - 'null' format: int64 x-go-name: EntityId x-go-package: magneto/base/magneto.pb VolumeInfo_DiskInfo: type: object title: Information about each disk in volume. properties: diskFileName: description: Disk name. This is the vmdk names, and not the flat file name. type: - string - 'null' x-go-name: DiskFileName diskFormat: description: 'Disk format type of this file. See util/disklib/base/enums.proto for available types.' type: - integer - 'null' format: int32 x-go-name: DiskFormat diskUuid: description: Disk uuid. type: - string - 'null' x-go-name: DiskUuid partitionType: description: Disk partition type. type: - integer - 'null' format: int32 x-go-name: PartitionType partitionVec: description: Information about all the partitions in this disk. type: - array - 'null' items: $ref: '#/components/schemas/VolumeInfo_DiskInfo_PartitionInfo' x-go-name: PartitionVec physicalRangeVec: description: 'This disk is formed by following physical ranges. Ranges are arranged sequentially to form a disk.' type: - array - 'null' items: $ref: '#/components/schemas/VolumeInfo_DiskInfo_PhysicalRange' x-go-name: PhysicalRangeVec sectorSize: description: 'Sector size of disk. This is sector size of disk which is formed by mapping the physical ranges of the disk into a linear device.' type: - integer - 'null' format: int64 x-go-name: SectorSize vmdkSize: description: Disk size in bytes. type: - integer - 'null' format: int64 x-go-name: VmdkSize x-go-package: yoda/base/volume_info.pb RestoreObjectParams: type: object title: The parameters that control the various options to restore a RestoreObject. properties: action: description: The action to perform. type: - integer - 'null' format: int32 x-go-name: Action datastoreEntity: description: 'A datastore entity where the object''s files should be restored to. This field is optional if object is being restored to its original parent source. If not specified, the object''s files will be restored to their original datastore locations. This field is mandatory if object is being restored to a different resource pool or to a different parent source.' $ref: '#/components/schemas/EntityProto' powerStateConfig: description: 'Semantics for kCloneVMs task: By default, objects are restored in the powered off state. Semantics for kRecoverVMs task: By default, objects are restored in the powered on state. This proto can be used to override the default behavior for kCloneVMs or kRecoverVMs task.' title: The power state configuration to be applied to the restored object. $ref: '#/components/schemas/PowerStateConfigProto' renameRestoredObjectParam: description: 'By default, objects are restored with their original name. This field can be used to specify the transformation ( i.e prefix/suffix) to be applied to the source object name to derive the new name of the restored object.' $ref: '#/components/schemas/RenameObjectParamProto' resourcePoolEntity: description: 'This field is optional for a kRecoverVMs task if the objects are being restored to its original parent source. If not specified, restored objects will be attached to its original resource entity. This field is mandatory if objects are being restored to a different parent source.' title: 'The resource pool entity where the restored objects will be attached. This field is mandatory for a kCloneVMs task.' $ref: '#/components/schemas/EntityProto' restoreParentSource: description: 'An optional registered parent source to which objects are to be restored. If not specified, objects are restored back to the original source that was managing the objects.' $ref: '#/components/schemas/EntityProto' restoredObjectsNetworkConfig: description: 'Semantics for kCloneVMs task: By default, if objects are being restored to their original location, then network will be disabled. If objects are being restored to a different location (i.e., either to different resource pool or to different parent source), then network will be detached. Semantics for kRecoverVMs task: By default, if objects are being restored to their original location, then original network configuration will be preserved. If objects are being restored to different location, (i.e., either to different resource pool or to different parent source), then network will be detached. Below field can be used to override the default network configuration of the restored objects. If user want to keep the original network setting for kRecoverVMs task, then this proto should not be set.' title: The network configuration to be applied to the restored object. $ref: '#/components/schemas/RestoredObjectNetworkConfigProto' viewName: description: Target view into which the objects are to be cloned. type: - string - 'null' x-go-name: ViewName x-go-package: magneto/base/magneto.pb CloneRefreshRequest: description: Specifies the settings for creating a new clone refresh task. type: object title: Clone Refresh Request Parameters. required: - name properties: cloneTaskId: description: 'Specifies the ID of the clone task. This is required to determine the details of the clone to be refreshed as clone task contains the details of the clone.' type: - integer - 'null' format: int64 x-go-name: CloneTaskId continueOnError: description: 'Specifies if the Restore Task should continue when some operations on some objects fail. If true, the Cohesity Cluster ignores intermittent errors and restores as many objects as possible.' type: - boolean - 'null' x-go-name: ContinueOnError name: description: 'Specifies the name of the Restore Task. This field must be set and must be a unique name.' type: - string - 'null' x-go-name: Name newParentId: description: 'Specify a new registered parent Protection Source. If specified the selected objects are cloned or recovered to this new Protection Source. If not specified, objects are cloned or recovered to the original Protection Source that was managing them.' type: - integer - 'null' format: int64 x-go-name: NewParentId objects: description: 'Array of Objects. Specifies a list of Protection Source objects or Protection Job objects (with specified Protection Source objects).' type: - array - 'null' items: $ref: '#/components/schemas/RestoreObjectDetails' x-go-name: Objects refreshTimeSecs: description: 'Specifies a point in time (unix epoch) to which the database needs to be refreshed. This helps granular refresh of the database. If this is set, relevant archive logs (redo logs) will also be re-played to match with the specified time. For this, the log backup should be enabled in the backup policy. If this is not set, then only the incremental backup data will be used to refresh the target database.' type: - integer - 'null' format: int64 x-go-name: RefreshTimeSecs sourceDatabaseId: description: 'Specifies the ID of the source database in the backup job snapshot. This is the entity ID of the database, which needs to be used as a source during the refresh process.' type: - integer - 'null' format: int64 x-go-name: SourceDatabaseId vlanParameters: description: Specifies VLAN parameters for the restore operation. $ref: '#/components/schemas/VlanParameters' x-go-package: cohesity/iris/server/data/public DeployVMsToAWSParams: description: 'Contains AWS specific information needed to identify various resources when converting and deploying a VM to AWS.' type: object properties: instanceType: description: Type of VM when cloning the VM in AWS as an instance. $ref: '#/components/schemas/EntityProto' keyPairName: description: 'Optional key-pair (public-private) name that can be used to login to an VM instance. In such case, user should have already created a key-pair and have a copy of the private key.' $ref: '#/components/schemas/EntityProto' networkSecurityGroups: description: 'Names of the network security groups within the above VPC. At least one entry should be present.' type: - array - 'null' items: $ref: '#/components/schemas/EntityProto' x-go-name: NetworkSecurityGroups proxyVmSubnet: description: 'Name of the subnet within the above VPC which will be associated with the proxy vm.' $ref: '#/components/schemas/EntityProto' proxyVmVpc: description: Virtual Private Cloud (VPC) in which the proxy vm will be deployed. $ref: '#/components/schemas/EntityProto' rdsParams: description: 'Proto containing the additional parameters required for restoring RDS DB. This field will only be populated for RDS restores.' $ref: '#/components/schemas/DeployDBInstancesToRDSParams' region: description: Name of the AWS region in which to deploy the VM. $ref: '#/components/schemas/EntityProto' subnet: description: Name of the optional subnet within the above VPC. $ref: '#/components/schemas/EntityProto' vpc: description: The Virtual Private Cloud (VPC) to choose for the instance. $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/cloud_deploy.pb UniversalIdProto: type: object properties: clusterId: description: The id of the cluster at which the object was created. type: - integer - 'null' format: int64 x-go-name: ClusterId clusterIncarnationId: description: The incarnation id of the above cluster. type: - integer - 'null' format: int64 x-go-name: ClusterIncarnationId objectId: description: The object id - this is unique within the above cluster. type: - integer - 'null' format: int64 x-go-name: ObjectId x-go-package: util/base/universal_id.pb ClusterConfigProto_StoragePolicyOverride: type: object title: The following describes the overridden storage policy. properties: disableInlineDedupAndCompression: description: 'If this is set to true, we will not do inline dedup and compression even if deduplicate_compress_delay_secs is set to 0 in the view box''s storage policy.' type: - boolean - 'null' x-go-name: DisableInlineDedupAndCompression x-go-package: configs/cluster_config.pb CommonACLProto: description: 'Protobuf that describes the Common access control list (ACL) permissions for a swift container. TODO (avinash_aita): Verify the ''.rlistings'' write ACL behavior. If necessary, remove persisting ''write_rlistings'' field and fail such requests.' type: object properties: readGrantees: description: Read permissions granted to grantees. $ref: '#/components/schemas/CommonACLProto_Grantees' writeRlistings: description: Write permissions granted to grantees. type: - boolean - 'null' x-go-name: WriteRlistings x-go-package: bridge/s3_portal/base/s3_metadata.pb GranteeProto: type: object title: Message to define a grantee to which ACL permissions can be granted. properties: emailAddress: description: 'If grantee is of type ''kEmailUser'', this field will contain the email address of the user.' type: - string - 'null' x-go-name: EmailAddress group: description: 'If grantee is of type ''kGroup'', this field will contain the group to which permission is granted.' type: - integer - 'null' format: int32 x-go-name: Group type: type: - integer - 'null' format: int32 x-go-name: Type userId: description: 'If grantee is of type ''kRegisteredUser'', this field will contain the canonical id of the user.' type: - string - 'null' x-go-name: UserId x-go-package: bridge/s3_portal/base/s3_metadata.pb SetupRestoreDiskTaskInfoProto: description: 'Each available extension is listed below along with the location of the proto file (relative to magneto/connectors) where it is defined. SetupRestoreDiskTaskInfoProto extension, extension_number Location ============================================================================= vmware::SetupRestoreDiskTaskInfo vmware_setup_restore_disk_task_info, 100 connectors/vmware/vmware_setup_restore_disks.proto.proto AgentSetupRestoreDiskTaskInfo agent_setup_restore_disk_task_info, 101 base/agent.proto app_file::SetupRestoreTaskInfo app_file_setup_restore_task_info, 102 connectors/app_file/app_file_setup_restore.proto hyperv::SetupRestoreDiskTaskInfo hyperv_setup_restore_disk_task_info, 103 connectors/hyperv/hyperv_setup_restore_disks.proto =============================================================================' type: object title: 'Message that encapsulates information about the task that sets up and tears down restore disks in environments such as VMware, Physical, and HyperV. Environment specific information is defined as extensions to this proto.' properties: entity: description: The entity on which disks will be setup. $ref: '#/components/schemas/EntityProto' progressMonitorRootTaskPath: description: The path to the progress monitor root task if any. type: - string - 'null' x-go-name: ProgressMonitorRootTaskPath rootEntity: description: The root entity that the entity was running under. $ref: '#/components/schemas/EntityProto' sourceViewName: description: The source view which contains the backups for the 'entity'. type: - string - 'null' x-go-name: SourceViewName taskId: description: The id of the associated task. type: - integer - 'null' format: int64 x-go-name: TaskId viewBoxId: description: The view box id containing the backups for the 'entity'. type: - integer - 'null' format: int64 x-go-name: ViewBoxId viewName: description: Destination view into which the files will be cloned. type: - string - 'null' x-go-name: ViewName x-go-package: magneto/base/magneto.pb RestoreADAppObjectParams: type: object title: The application object restore params for AD objects (AD Domain Controller). properties: adRestoreStatusVec: description: Status of the AD object/attribute restore operation. type: - array - 'null' items: $ref: '#/components/schemas/ADRestoreStatus' x-go-name: AdRestoreStatusVec adUpdateOptions: description: 'This option will only be set for child tasks (Restore AD objects and Restore AD object attributes).' $ref: '#/components/schemas/ADUpdateRestoreTaskOptions' credentials: description: 'Credentials used to execute AD powershell cmdlet for AD search and restore. The specified credentials must have required permissions to AD objects in specified OU.' $ref: '#/components/schemas/Credentials' ldapPort: description: 'The ldap port on which the AD domain controller''s NTDS database will be mounted.' type: - integer - 'null' format: int32 x-go-name: LdapPort numFailed: description: 'Number of AD objects whose restore failed. Includes both AD object and attribute restored.' type: - integer - 'null' format: int32 x-go-name: NumFailed numRunning: description: 'Number of AD objects whose restores are currently running. Includes both AD object and attribute recoveries.' type: - integer - 'null' format: int32 x-go-name: NumRunning numSuccessfull: description: 'Number of AD objects restored successfully. Includes both AD object and attribute restored.' type: - integer - 'null' format: int32 x-go-name: NumSuccessfull shouldMountAndRestore: description: 'The following field is set if user wants to mount AD, restore AD objects and destory AD mount in single task.' type: - boolean - 'null' x-go-name: ShouldMountAndRestore x-go-package: magneto/base/magneto.pb HBaseConnectParams: description: 'Specifies an Object containing information about a registered HBase source.' type: object title: HBase Connect Params. properties: hdfsEntityId: description: The entity id of the HDFS source for this HBase type: - integer - 'null' format: int64 x-go-name: HdfsEntityId kerberosPrincipal: description: Specifies the kerberos principal. type: - string - 'null' x-go-name: KerberosPrincipal rootDataDirectory: description: Specifies the HBase data root directory. type: - string - 'null' x-go-name: RootDataDirectory zookeeperQuorum: description: Specifies the HBase zookeeper quorum. type: - array - 'null' items: type: string x-go-name: ZookeeperQuorum x-go-package: cohesity/iris/server/data/public RestoreOutlookParams_Mailbox: type: object properties: folderVec: description: 'If is_entire_mailbox_required is set to false, user will then specify which particular folders are to be restored.' type: - array - 'null' items: $ref: '#/components/schemas/RestoreOutlookParams_Folder' x-go-name: FolderVec isEntireMailboxRequired: description: Specify if the entire mailbox is to be restored. type: - boolean - 'null' x-go-name: IsEntireMailboxRequired object: description: 'This will store the details of the mailbox to be restored.' $ref: '#/components/schemas/RestoreObject' x-go-package: magneto/base/magneto.pb RecoverVolumesParams_Mapping: type: object title: Represents a single source/destination pair for the block-based restore. properties: dstGuid: description: The destination, pertains to the newly rebuilt system. type: - string - 'null' x-go-name: DstGuid srcGuid: description: The source, pertains to the original backup. type: - string - 'null' x-go-name: SrcGuid x-go-package: magneto/base/magneto.pb ACLProto: description: 'Protobuf that describes the access control list (ACL) permissions for a bucket or for an object.' type: object properties: commonAcl: description: CommonACL of the Swift container. $ref: '#/components/schemas/CommonACLProto' grantVec: type: - array - 'null' items: $ref: '#/components/schemas/ACLProto_Grant' x-go-name: GrantVec keystoneAcl: description: KeystoneACL of the Swift container. $ref: '#/components/schemas/KeystoneACLProto' swiftReadAcl: description: Swift ACL strings. type: - string - 'null' x-go-name: SwiftReadAcl swiftWriteAcl: type: - string - 'null' x-go-name: SwiftWriteAcl x-go-package: bridge/s3_portal/base/s3_metadata.pb DeviceTree_PartitionSlice: type: object title: This defines the leaf of the device tree mentioned above. properties: diskFileName: description: The disk to use. type: - string - 'null' x-go-name: DiskFileName length: description: 'The length of data for the LVM volume (for which this device tree is being built) in bytes. It does not include size of the LVM meta data.' type: - integer - 'null' format: int64 x-go-name: Length lvmDataOffset: description: 'Each LVM partition starts with LVM meta data. After the meta data there can be data for one or more LVM volumes. This field indicates the offset in bytes (relative to partition) where data for various LVM volumes starts on the partition. NOTE: If this device tree represents first LVM volume on the partition, ''lvm_data_offset'' is equal to ''offset''.' type: - integer - 'null' format: int64 x-go-name: LvmDataOffset offset: description: 'This is the offset (in bytes) where data for the LVM volume (for which this device tree is being build) starts relative to the start of the partition above.' type: - integer - 'null' format: int64 x-go-name: Offset partitionNumber: description: The partition to use in the disk above. type: - integer - 'null' format: int32 x-go-name: PartitionNumber x-go-package: yoda/base/volume_info.pb VaultParams_RestoreParams_Glacier: type: object title: Params for Glacier. properties: retrievalType: type: - integer - 'null' format: int32 x-go-name: RetrievalType x-go-package: bridge/vault/base/vault.pb RetrieveArchiveTaskStateProto: description: 'Persistent state of a retrieve of an archive task. Only one of either entity_vec or download_files_info needs to be specified in this proto, where entity_vec is for retrieving the whole objects from the archive, and download_files_info is for only downloading the specified files from the archive.' type: object properties: archivalTarget: description: Target from which to retrieve the archive. $ref: '#/components/schemas/ArchivalTarget' archiveTaskUid: description: The uid of the archive to be retrieved. $ref: '#/components/schemas/UniversalIdProto' backupRunStartTimeUsecs: description: 'The start time of the backup run whose corresponding archive is being retrieved. This field is just used for logging purposes.' type: - integer - 'null' format: int64 x-go-name: BackupRunStartTimeUsecs cancellationRequested: description: Whether this retrieval task has a pending cancellation request. type: - boolean - 'null' x-go-name: CancellationRequested downloadFilesInfo: $ref: '#/components/schemas/RetrieveArchiveTaskStateProto_DownloadFilesInfo' endTimeUsecs: description: 'If the retrieval task has finished, this field contains the end time for the task.' type: - integer - 'null' format: int64 x-go-name: EndTimeUsecs entityVec: description: 'Information on the exact set of objects to retrieve from archive. Even if the user wanted to retrieve all objects from the archive, this field will contain all individual leaf-level objects.' type: - array - 'null' items: $ref: '#/components/schemas/EntityProto' x-go-name: EntityVec error: description: 'The error encountered by task (if any). Only valid if the task has finished.' $ref: '#/components/schemas/ErrorProto' fullViewName_DEPRECATED: description: 'The full view name (external). This is composed of a Cohesity specific prefix and the user provided view name.' type: - string - 'null' x-go-name: FullViewName_DEPRECATED jobUid: description: The uid of the job to which the archive to be retrieved belongs to. $ref: '#/components/schemas/UniversalIdProto' name: description: The name of the retrieval task. type: - string - 'null' x-go-name: Name progressMonitorTaskPath: description: The path of the progress monitor for this task. type: - string - 'null' x-go-name: ProgressMonitorTaskPath restoreArchiveFilesInfo: description: 'Information of the files to restore from archive to source. Only one of download_files_info or restore_archive_files_info has to be populated to trigger download files or restore files from archive correspondingly.' $ref: '#/components/schemas/RetrieveArchiveTaskStateProto_DownloadFilesInfo' restoreTaskId: description: 'For retrieve tasks created after the 2.8 release, this will contain the id of the restore task that created this retrieve task.' type: - integer - 'null' format: int64 x-go-name: RestoreTaskId retrievalInfo: description: 'Information about the retrieval task. This proto is created by the master and info in the proto is periodically updated by querying Icebox.' $ref: '#/components/schemas/RetrieveArchiveInfo' startTimeUsecs: description: The start time for this retrieval task. type: - integer - 'null' format: int64 x-go-name: StartTimeUsecs status: description: The status of this task. type: - integer - 'null' format: int32 x-go-name: Status taskUid: description: The globally unique id for this retrieval of an archive task. $ref: '#/components/schemas/UniversalIdProto' user: description: The user who requested this retrieval task. type: - string - 'null' x-go-name: User vaultRestoreParams: description: Params to be passed to Icebox while restoring data from an archive. $ref: '#/components/schemas/VaultParams_RestoreParams' viewBoxId: description: The view box id to which 'view_name' belongs to. type: - integer - 'null' format: int64 x-go-name: ViewBoxId viewName_DEPRECATED: description: 'The view name as provided by the user for this retrieval task. Retrieved snapshots of the entities will be placed in this view.' type: - string - 'null' x-go-name: ViewName_DEPRECATED x-go-package: magneto/master/base/master.pb RestoreAppTaskStateProto: type: object properties: appRestoreProgressMonitorSubtaskPath: description: 'The Pulse task path to the application restore task sub tree. If the application restore has to wait on other tasks (for example, a SQL db restore may wait for a tail log backup or a VM restore), then this would represent a sub-tree of ''progress_monitor_task_path'' in PerformRestoreTaskStateProto.' type: - string - 'null' x-go-name: AppRestoreProgressMonitorSubtaskPath childRestoreAppParamsVec: description: 'This has list of the restore app params for all the child restore tasks. This is populated iff the ''is_parent_task'' is set to true.' type: - array - 'null' items: $ref: '#/components/schemas/RestoreAppParams' x-go-name: ChildRestoreAppParamsVec lastFinishedLogBackupStartTimeUsecs: description: 'The start time of the last finished log backup run. For SQL application, this is set iff we need to take a tail log backup.' type: - integer - 'null' format: int64 x-go-name: LastFinishedLogBackupStartTimeUsecs restoreAppParams: description: Information about the application restore task. $ref: '#/components/schemas/RestoreAppParams' x-go-package: magneto/master/base/master.pb CassandraConnectParams: description: 'Specifies an Object containing information about a registered cassandra source.' type: object title: Cassandra Connect Params. properties: cassandraPortsInfo: description: Specifies the ports related info. $ref: '#/components/schemas/CassandraPortsInfo' cassandraSecurityInfo: description: Specifies the security related info. $ref: '#/components/schemas/CassandraSecurityInfo' cassandraVersion: description: Cassandra version type: - string - 'null' x-go-name: CassandraVersion configDirectory: description: Specifies the Directory path containing Config YAML for discovery. type: - string - 'null' x-go-name: ConfigDirectory dataCenters: description: 'Specifies the List of all physical data center or virtual data center. In most cases, the data centers will be listed after discovery operation however, if they are not listed, you must manually type the data center names. Leaving the field blank will disallow data center-specific backup or restore. Entering a subset of all data centers may cause problems in data movement.' type: - array - 'null' items: type: string x-go-name: DataCenters dseConfigDirectory: description: Specifies the Directory from where DSE specific configuration can be read. type: - string - 'null' x-go-name: DseConfigDirectory isDseAuthenticator: description: Specifies whether this cluster has DSE Authenticator. type: - boolean - 'null' x-go-name: IsDseAuthenticator isDseTieredStorage: description: Specifies whether this cluster has DSE tiered storage. type: - boolean - 'null' x-go-name: IsDseTieredStorage isJmxAuthEnable: description: Specifies if JMX Authentication enabled in this cluster. type: - boolean - 'null' x-go-name: IsJmxAuthEnable kerberosPrincipal: description: Specifies the Kerberos Principal for Kerberos connection type: - string - 'null' x-go-name: KerberosPrincipal primaryHost: description: Specifies the Primary Host for the Cassandra cluster. type: - string - 'null' x-go-name: PrimaryHost seeds: description: Specifies the Seed nodes of this Cassandra cluster. type: - array - 'null' items: type: string x-go-name: Seeds solrNodes: description: Specifies the Solr node IP Addresses type: - array - 'null' items: type: string x-go-name: SolrNodes solrPort: description: Specifies the Solr node Port. type: - integer - 'null' format: int32 x-go-name: SolrPort x-go-package: cohesity/iris/server/data/public GcpParams: description: Specifies various resources when converting and deploying a VM to GCP. type: object title: GCP Parameters. properties: instanceId: description: Specifies id of the GCP instance type in which to deploy the VM. type: - integer - 'null' format: int64 x-go-name: ProjectId region: description: Specifies id of the GCP region in which to deploy the VM. type: - integer - 'null' format: int64 x-go-name: RegionId subnetId: description: Specifies id of the subnet within above VPC. type: - integer - 'null' format: int64 x-go-name: Subnet virtualPrivateCloudId: description: Specifies id of the Virtual Private Cloud to chose for the instance type. type: - integer - 'null' format: int64 x-go-name: Zone x-go-package: cohesity/iris/server/data/public EntityProto: description: Specifies the attributes and the latest statistics about an entity. type: object title: Entity. properties: attributeVec: description: 'Array of Attributes. List of attributes of an entity.' type: - array - 'null' items: $ref: '#/components/schemas/KeyValuePair' x-go-name: AttributeVec entityId: description: Specifies a globally unique identifier of an entity. $ref: '#/components/schemas/EntityIdentifier' latestMetricVec: description: 'Array of Metric Statistics. List of the latest statistics for all metrics defined in the schema that this entity belongs to. If statistics for a metric is not available, then that data point is not returned.' type: - array - 'null' items: $ref: '#/components/schemas/MetricValue' x-go-name: LatestMetricVec x-go-package: stats/base/stats.pb OracleDBConfig: description: 'This proto captures the oracle database configuration for alternate DB restore.' type: object properties: auditLogDest: description: Audit log destination. type: - string - 'null' x-go-name: AuditLogDest bctFilePath: description: BCT file path. type: - string - 'null' x-go-name: BctFilePath controlFilePathVec: description: List of paths where the control file needs to be multiplexed. type: - array - 'null' items: type: string x-go-name: ControlFilePathVec dbConfigFilePath: description: 'Path to the file on oracle host which decides the configuration of restored DB.' type: - string - 'null' x-go-name: DbConfigFilePath diagDest: description: Diag destination. type: - string - 'null' x-go-name: DiagDest enableArchiveLogMode: description: If set to false, archive log mode is disabled. type: - boolean - 'null' x-go-name: EnableArchiveLogMode fraDest: description: FRA path. type: - string - 'null' x-go-name: FraDest fraSizeMb: description: FRA Size in MBs. type: - integer - 'null' format: int32 x-go-name: FraSizeMb numTempfiles: description: How many tempfiles to use for the recovered database. type: - integer - 'null' format: int32 x-go-name: NumTempfiles pfileParameterMap: description: Map of pfile parameters to its values. type: - array - 'null' items: $ref: '#/components/schemas/OracleDBConfig_PfileParameterMapEntry' x-go-name: PfileParameterMap redoLogConf: description: List of redo log groups for this DB. $ref: '#/components/schemas/OracleDBConfig_RedoLogGroupConf' sgaTargetSize: description: SGA_TARGET_SIZE size [ Default value same as Source DB ]. type: - string - 'null' x-go-name: SgaTargetSize sharedPoolSize: description: Shared pool size [ Default value same as Source DB ]. type: - string - 'null' x-go-name: SharedPoolSize x-go-package: magneto/base/magneto.pb RecoverVolumesParams: type: object title: Contains information for recovering volumes in the Physical environment. properties: forceUnmountVolume: description: Whether volume would be dismounted first during LockVolume failure type: - boolean - 'null' x-go-name: ForceUnmountVolume mappingVec: description: Contains the volume mapping data that defines the restore task. type: - array - 'null' items: $ref: '#/components/schemas/RecoverVolumesParams_Mapping' x-go-name: MappingVec targetEntity: description: Target entity where the volumes are being mounted. $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/magneto.pb RestoreObject: type: object title: Captures information about an object being restored. properties: archivalTarget: description: 'This field must be set if the object is to be restored/retrieved from an archive.' $ref: '#/components/schemas/ArchivalTarget' attemptNum: description: The attempt number of the job run to restore from. type: - integer - 'null' format: int32 x-go-name: AttemptNum cloudDeployTarget: description: 'This field must be set if the restore type is kDeployVMs and the object is to be deployed to cloud using a previously converted image.' $ref: '#/components/schemas/CloudDeployTarget' cloudReplicationTarget: description: 'This field must be set if the restore type is kReplicateSnapshots and the snapshots need to be repliated accross regions in the Cloud.' $ref: '#/components/schemas/CloudDeployTarget' entity: description: 'The entity to restore. If this is not specified, all entities from job id will be restored (from the latest snapshot). If specified, this can only have leaf-level entities. Notes: This must be specified for RestoreFiles task. Disable object rewriting in the outgoing API path. This is needed to preserve the content of objects().entity() as it must reflect the Entity object as it was at the point the restore task was submitted.' $ref: '#/components/schemas/EntityProto' jobId: description: 'The job id from which to restore. This is used while communicating with yoda.' type: - integer - 'null' format: int64 x-go-name: JobId jobInstanceId: description: 'Id identifying a specific run to restore from. If this is not specified, and we need to restore from a run, the latest run is used. NOTE: This must be specified for RestoreFiles, RecoverDisks and GetVirtualDisks APIs.' type: - integer - 'null' format: int64 x-go-name: JobInstanceId jobUid: description: The universal id of the job from which to restore. $ref: '#/components/schemas/UniversalIdProto' nosqlRecoverParams: description: This field contains params specific to the restore of a nosql entity. $ref: '#/components/schemas/NoSqlRecoverParams' parentSource: description: The registered source that was managing the entity being restored. $ref: '#/components/schemas/EntityProto' pointInTimeRestoreTimeUsecs: description: 'The time to which the object needs to be restored. If this is not set, then the object will be restored to the full/incremental snapshot. This is applicable only if the object is protected using CDP.' type: - integer - 'null' format: int64 x-go-name: PointInTimeRestoreTimeUsecs restoreAcropolisVmParam: description: This field contains params specific to the restore of an Acropolis VM. $ref: '#/components/schemas/RestoreAcropolisVMParam' snapshotRelativeDirPath: description: The relative path to the directory containing the entity's snapshot. type: - string - 'null' x-go-name: SnapshotRelativeDirPath startTimeUsecs: description: 'The start time of the specific job run. Iff ''job_instance_id'' is set, this field must be set. In-memory indices on the Magneto master are laid-out by the start time of the job, and this is how the master pulls up a specific run. NOTE: This must be specified for RestoreFiles, RecoverDisks and GetVirtualDisks APIs' type: - integer - 'null' format: int64 x-go-name: StartTimeUsecs viewName: description: The name of the view where the object's snapshot is located. type: - string - 'null' x-go-name: ViewName vmHadIndependentDisks: description: 'This is applicable only to VMs and is set to true when the VM being recovered or cloned contained independent disks when it was backed up.' type: - boolean - 'null' x-go-name: VmHadIndependentDisks x-go-package: magneto/base/magneto.pb Project: type: object title: Keystone project proto. properties: domain: description: Domain to which the project is scoped. $ref: '#/components/schemas/Domain' domainId: description: 'The ID of the domain to which the project is scoped. This field is used in the reponse of Keystone API.' type: - string - 'null' x-go-name: DomainId id: description: The ID of the project. type: - string - 'null' x-go-name: Id name: description: The name of the project. type: - string - 'null' x-go-name: Name x-go-package: bridge/s3_portal/keystone/keystone2.pb RestoreSiteParams_SiteOwner: type: object properties: driveVec: description: The list of drives that are being restored. type: - array - 'null' items: $ref: '#/components/schemas/RestoreSiteParams_SiteOwner_Drive' x-go-name: DriveVec object: description: This will store the details of the user whose drives is to be restored. $ref: '#/components/schemas/RestoreObject' x-go-package: magneto/base/magneto.pb SwiftContainerTaggingProto: type: object title: Proto to define the tagging info associated with a Swift container. properties: aclRootUser: description: '[optional] The Keystone user who could get grant of access to this container after creation by ACL. It is used to let this user get access to this container if noboby has any Swift roles from Keystone. If this user has a Swift role, other Keystone users could get grant by this ''root'' user through ACL. If ''acl_root_user'' is set, below fields are mandatory. [mandatory] acl_root_user.name [mandatory] acl_root_user.domain.name' $ref: '#/components/schemas/User' projectTag: description: '[mandatory] The Keystone project this Swift container belongs to. Below fields are mandatory. [mandatory] project_tag.name [mandatory] project_tag.domain.name' $ref: '#/components/schemas/Project' x-go-package: bridge/s3_portal/base/s3_metadata.pb CassandraRecoverJobParams: description: 'Contains any additional cassandra environment specific params for the recover job.' type: object properties: cassandraAdditionalInfo: description: 'Additional parameters required for Cassandra recovery. TODO (faizan.khan) : Remove this.' $ref: '#/components/schemas/CassandraAdditionalParams' cassandraSourceVersion: description: Cassandra source version type: - string - 'null' x-go-name: CassandraSourceVersion selectedDataCenterVec: description: The data centers selected for recovery. type: - array - 'null' items: type: string x-go-name: SelectedDataCenterVec stagingDirectoryVec: description: Cassandra staging directory type: - array - 'null' items: type: string x-go-name: StagingDirectoryVec suffix: description: 'A suffix that is to be applied to all recovered entities TODO (faizan.khan) : Remove this.' type: - string - 'null' x-go-name: Suffix x-go-package: magneto/base/nosql.pb DeviceTree_ChildDevice: type: object title: The list of devices that need to be combined. properties: device: description: 'Recursion: This device is defined recursively.' $ref: '#/components/schemas/DeviceTree' deviceType: description: This specifies how the parent device is using this child device. type: - integer - 'null' format: int32 x-go-name: DeviceType partitionSlice: description: 'Base case: this is a partition slice.' $ref: '#/components/schemas/DeviceTree_PartitionSlice' x-go-package: yoda/base/volume_info.pb NoSqlRestoreObject_ObjectRestorePropertiesMapEntry: type: object properties: key: type: - string - 'null' x-go-name: Key value: type: - string - 'null' x-go-name: Value x-go-package: magneto/base/nosql.pb MountVolumesParams: type: object title: Contains information needed when mounting volumes. properties: hypervParams: description: 'Environment specific additional params if any. This is populated for HyperV environments.' $ref: '#/components/schemas/MountVolumesHyperVParams' readonlyMount: description: 'Allows the caller to force the Agent to perform a read-only mount. This is not usually required and we want to give customers the ability to mutate this mount for test/dev purposes.' type: - boolean - 'null' x-go-name: ReadonlyMount targetEntity: description: 'Target entity where the volumes are being mounted. NOTE: The source entity from which the backup was done and the target entity must be of the same type, i.e if the source entity is a VMware VM, then the target entity should be a VMware VM as well.' $ref: '#/components/schemas/EntityProto' useExistingAgent: description: 'Whether this will use an existing agent on the target vm to do a restore operation.' type: - boolean - 'null' x-go-name: UseExistingAgent vmwareParams: description: 'Environment specific additional params if any. This is populated for VMware environments.' $ref: '#/components/schemas/MountVolumesVMwareParams' volumeNameVec: description: 'Optional names of volumes that need to be mounted. The names here correspond to the volume names obtained by Iris from Yoda as part of VMVolumeInfo call. NOTE: If this is not specified then all volumes that are part of the server will be mounted on the target entity.' type: - array - 'null' items: type: string x-go-name: VolumeNameVec x-go-package: magneto/base/magneto.pb KeystoneACLProto_Grantees: type: object properties: allUsers: description: This field indicates if all users are granted ACL permission. type: - boolean - 'null' x-go-name: AllUsers projectIdVec: description: 'This field holds a list of Keystone project ids whose users are granted ACL permission.' type: - array - 'null' items: type: string x-go-name: ProjectIdVec projectUsersMap: type: - array - 'null' items: $ref: '#/components/schemas/KeystoneACLProto_Grantees_ProjectUsersMapEntry' x-go-name: ProjectUsersMap roleNameVec: description: 'This field holds a list of Keystone roles for which any Keystone user with one (or more) of the roles on the project containing the swift container holding this KeystoneACLProto is granted ACL permission.' type: - array - 'null' items: type: string x-go-name: RoleNameVec userIdVec: description: 'This field holds a list of keystone user ids who are granted ACL permission.' type: - array - 'null' items: type: string x-go-name: UserIdVec x-go-package: bridge/s3_portal/base/s3_metadata.pb ADAttributeRestoreParam: type: object title: AD attribute recovery parameters for one or more AD objects. properties: excludedPropertyVec: description: 'Array of LDAP property names to excluded from ''property_vec''. Excluded property name cannot contain wildcard character ''*''. Property names are case insensitive.' type: - array - 'null' items: type: string x-go-name: ExcludedPropertyVec guidpairVec: description: 'Array of source and destination object guid pairs to restore attributes. Pair source guid refers to guid in AD snapshot in source_server endpoint. Destination guid refers to guid in production AD. If destination guid is empty, then source guid in AD snapshot should exist in production AD.' type: - array - 'null' items: $ref: '#/components/schemas/ADGuidPair' x-go-name: GuidpairVec optionFlags: description: Attribute restore option flags of type ADAttributeOptionFlags. type: - integer - 'null' format: uint32 x-go-name: OptionFlags propertyVec: description: 'Array of LDAP property(attribute) names. The name can be standard or custom property defined in AD schema partition. The property can contain wildcard character ''*''. If this array is empty, then ''*'' is assigned, means restore all properties except default system excluded properties. Wildcards will be expanded. If ''memberOf'' property is included, group membership of the objects specified in ''guid_vec'' will be restored. Property that does not exist for an object is ignored and no error info is returned for that property. Property names are case insensitive. Caller may check the ADAttributeFlags.kSystem obtained during object compare to exclude system properties.' type: - array - 'null' items: type: string x-go-name: PropertyVec srcSysvolFolder: description: When restoring a GPO, need to know the absolute path for SYSVOL folder. type: - string - 'null' x-go-name: SrcSysvolFolder x-go-package: magneto/agents/windows/stub/ad_param.pb DeviceTree: description: 'A logical volume is built on a tree where leaves are the slices of partitions (PartitionSlice) defined below and intermediate nodes are assembled by combining nodes in some mode (linear layout, striped, mirrored, RAID etc). A DeviceTree is a block device formed by combining one or more Devices using a combining strategy.' type: object properties: childVec: type: - array - 'null' items: $ref: '#/components/schemas/DeviceTree_ChildDevice' x-go-name: ChildVec deviceId: description: Internal device identifier of the device to be activated as a thin volume. type: - integer - 'null' format: int64 x-go-name: DeviceId deviceLength: description: 'The length of this device. This should match the length which is computable based on children and combining strategy. e.g. if there is only one partition slice in an LVM volume, ''length'' in the partition slice is equal to ''device_length''.' type: - integer - 'null' format: int64 x-go-name: DeviceLength stripeSize: description: 'In case data is striped, this represents the length of the stripe. The number of stripes is defined by the size of child_vec above.' type: - integer - 'null' format: int32 x-go-name: StripeSize thinPoolChunkSize: description: Chunk size. Only populated if device type is thin pool. type: - integer - 'null' format: int64 x-go-name: ThinPoolChunkSize type: description: How to combine the children. type: - integer - 'null' format: int32 x-go-name: Type x-go-package: yoda/base/volume_info.pb RemoteHostConnectorParams: type: object title: Contains parameters to connect to a remote host. properties: credentials: description: 'Credentials that will be used to login to the remote host. For env of type kLinux, it is expected that user has setup the password-less access to the remote host. So only username field MUST be specified.' $ref: '#/components/schemas/Credentials' hostAddress: description: 'Address (i.e., IP, hostname or FQDN) of the host to connect to. Magneto will connect using ssh or equivalent to the host.' type: - string - 'null' x-go-name: HostAddress hostType: description: Type of host to connect to. type: - integer - 'null' format: int32 x-go-name: HostType x-go-package: magneto/base/magneto.pb DeployVMsToAzureParams: description: 'Contains Azure specific information needed to identify various resources when converting and deploying a VM to Azure.' type: object properties: azureManagedDiskParams: description: Managed disk parameter if deployment is using managed disks. $ref: '#/components/schemas/AzureManagedDiskParams' computeOptions: description: Type of VM (e.g. small, medium, large) when cloning the VM in Azure. $ref: '#/components/schemas/EntityProto' networkResourceGroup: description: 'Name of the Azure resource group that has the virtual network mentioned below.' $ref: '#/components/schemas/EntityProto' networkSecurityGroup: description: 'Name of the network security group. It''s location should be same as the storage account.' $ref: '#/components/schemas/EntityProto' resourceGroup: description: 'Name of the Azure resource group. Its value is globally unique within Azure.' $ref: '#/components/schemas/EntityProto' storageAccount: description: 'Name of the storage account that will contain the storage container within which we will create the blob that will become the VHD disk for the cloned VM.' $ref: '#/components/schemas/EntityProto' storageContainer: description: Name of the storage container within the above storage account. $ref: '#/components/schemas/EntityProto' storageKey: description: The storage key for the above storage account. $ref: '#/components/schemas/EntityProto' storageResourceGroup: description: 'Name of the Azure resource group that has the storage account mentioned below.' $ref: '#/components/schemas/EntityProto' subnet: description: Name of the subnet within the above virtual network. $ref: '#/components/schemas/EntityProto' tempVmResourceGroup: description: Name of the resource group where the temporary VM needs to be created. title: 'Next few fields are for getting additional resources for creating temporary resources in Azure to create a temporary VM to convert the VM so that the guest VM will be Azure Compatible. The values are optional for customer to provide.' $ref: '#/components/schemas/EntityProto' tempVmStorageAccount: description: Name of the Storage Account where the temporary VM needs to be created. $ref: '#/components/schemas/EntityProto' tempVmStorageContainer: description: 'Name of the Storage container where the temporary VM''s OS Disk needs to be created.' $ref: '#/components/schemas/EntityProto' tempVmSubnet: description: 'Name of the Subnet within the temp_vm_virtual_network where the temporary vm needs to be created.' $ref: '#/components/schemas/EntityProto' tempVmVirtualNetwork: description: Name of the Virtual Network where the temporary VM needs to be created. $ref: '#/components/schemas/EntityProto' virtualNetwork: description: Name of the Virtual Network. $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/cloud_deploy.pb RestoreAcropolisVMParam_NetworkConfigInfo_NICSpec: type: object title: Proto to specify the NIC configuration. properties: ipAddress: description: IP address to assign to the NIC. type: - string - 'null' x-go-name: IpAddress networkUuid: description: The UUID of the network to which the NIC is to be attached. type: - string - 'null' x-go-name: NetworkUuid x-go-package: magneto/base/magneto.pb RestoreOutlookParams: type: object title: This message defines the Outlook specific restore params. properties: mailboxVec: description: 'In a RestoreJob , user will provide the list of mailboxes to be restored. Provision is there for restoring full AND partial mailbox recovery.' type: - array - 'null' items: $ref: '#/components/schemas/RestoreOutlookParams_Mailbox' x-go-name: MailboxVec targetFolderPath: type: - string - 'null' x-go-name: TargetFolderPath targetMailbox: description: 'This is the destination mailbox. All mailboxes listed in the mailbox_vec will be restored to this mailbox with appropriate names. Let''s say mailbox_vec is A and B; target_mailbox is C. The final folder-hierarchy after restore job is finished will look like this : C : {target_folder_path}/| |A/{whatever is there in mailbox A} |B/{whatever is inside B mailbox B}' $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/magneto.pb ScriptPathAndParams: description: 'A message to encapsulate pre or post script associated with a backup job policy.' type: object properties: continueOnError: description: 'Applicable only for pre backup scripts. If this flag is set to true, then backup job will start even if the pre backup script fails.' type: - boolean - 'null' x-go-name: ContinueOnError isActive: description: 'Indicates if the script is active. If ''is_active'' is set to false, this script will not be executed even if it is part of the backup job.' type: - boolean - 'null' x-go-name: IsActive scriptParams: description: 'Custom parameters that users want to pass to the script. For example, if user wants to pass following params: 1. foo=bar 2. v=10. User can construct the param string as "far=bar v=10".' type: - string - 'null' x-go-name: ScriptParams scriptPath: description: 'For backup jobs of type ''kPuppeteer'', ''script_path'' is full path of location of the script within the host. For Pre/Post scripts of agent-based backup jobs, ''script_path'' is just name of the script, not full path.' type: - string - 'null' x-go-name: ScriptPath timeoutSecs: description: 'Timeout of the script. The script will be killed if it exceeds this value. ''-1'' indicates that the timeout is not set for the script.' type: - integer - 'null' format: int32 x-go-name: TimeoutSecs x-go-package: magneto/base/magneto.pb RestoreSiteParams_SiteOwner_Drive: type: object properties: isEntireDriveRequired: description: 'Specify if the entire drive is to be restored. This field should be false if restore_item_vec size > 0.' type: - boolean - 'null' x-go-name: IsEntireDriveRequired restoreDriveId: description: Id of the drive whose items are being restored. type: - string - 'null' x-go-name: RestoreDriveId restoreDriveName: description: 'Specifies the name of the drive whos items are being restored. NOTE: For restore either the drive Id or the name must be populated.' type: - string - 'null' x-go-name: RestoreDriveName restorePathVec: description: List of drive paths that need to be restored. type: - array - 'null' items: $ref: '#/components/schemas/RestoreSiteParams_DriveItem' x-go-name: RestorePathVec x-go-package: magneto/base/magneto.pb RestoredObjectNetworkConfigProto: type: object properties: detachNetwork: description: 'If this is set to true, then the network will be detached from the recovered or cloned VMs. NOTE: If this is set to true, then all the following fields will be ignored.' type: - boolean - 'null' x-go-name: DetachNetwork disableNetwork: description: 'This can be set to true to indicate that the attached network should be left in disabled state.' type: - boolean - 'null' x-go-name: DisableNetwork mappings: description: The network mappings to be applied to the target object. type: - array - 'null' items: $ref: '#/components/schemas/NetworkMappingProto' x-go-name: Mappings networkEntity: description: 'The network entity (i.e, either a standard switch port group or a distributed port group in a VMware env) that will attached to the restored object.' $ref: '#/components/schemas/EntityProto' preserveMacAddressOnNewNetwork: description: 'If this is true and we are attaching to a new network entity, then the VM''s MAC address will be preserved on the new network.' type: - boolean - 'null' x-go-name: PreserveMacAddressOnNewNetwork vnicEntity: description: The VNicProfile that will be attached to the restored object. $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/magneto.pb PowerStateConfigProto: type: object title: Proto to specify the power state (i.e, power on or power off) of an object. properties: powerOn: type: - boolean - 'null' x-go-name: PowerOn x-go-package: magneto/base/magneto.pb VolumeInfo_DiskInfo_PartitionInfo: description: 'Offset/Length here is relative to the logical range starting at 0, formed by mapping the physical ranges of the disk into a linear device.' type: object title: Information about each Partition. properties: length: description: Length of partition in bytes. type: - integer - 'null' format: int64 x-go-name: Length partitionNumber: description: Partition number. type: - integer - 'null' format: int64 x-go-name: PartitionNumber partitionTypeUuid: description: 'Partition type uuid. If disk is unpartitioned, this field will not be set. If disk is MBR partitioned, this field will be set to partition type. Example: 83 (from below fdisk output) [This value is in hex] bash$ fdisk -l foobar.vmdk Device Boot Start End Sectors Size Id Type foobar.vmdk1 2048 1050623 1048576 512M 83 Linux If disk is GPT partitioned, this field will be set to partition type GUID. Example: fc63daf-8483-4772-8e793d69d8477de4 (Linux filesystem data)' type: - string - 'null' x-go-name: PartitionTypeUuid partitionUuid: description: 'Partition uuid. If disk is unpartitioned, this field will not be set. If disk is MBR partitioned, this field will not be set. If disk is GPT partitioned, this field will be set to partition GUID.' type: - string - 'null' x-go-name: PartitionUuid startOffset: description: Start offset of partition in bytes. type: - integer - 'null' format: int64 x-go-name: StartOffset x-go-package: yoda/base/volume_info.pb RestoreO365PublicFoldersParams_RootPublicFolder: type: object properties: folderVec: description: 'If is_entire_folder_required is set to false, user will then specify which particular sub-folders are to be restored.' type: - array - 'null' items: $ref: '#/components/schemas/RestoreO365PublicFoldersParams_PublicFolder' x-go-name: FolderVec isEntireRootFolderRequired: description: 'Specify if the entire Root Public Folder including the sub-folders is to be restored.' type: - boolean - 'null' x-go-name: IsEntireRootFolderRequired object: description: This will store the details of the Root Public Folder to be restored. $ref: '#/components/schemas/RestoreObject' x-go-package: magneto/base/magneto.pb ADGuidPair: type: object title: AD object guid string pair. properties: destination: description: 'Destination guid in production AD object corresponding to source. If empty, it assumed to be ''source'' guid.' type: - string - 'null' x-go-name: Destination source: description: 'Source guid string of an AD object in mounted AD snapshot. This cannot be empty.' type: - string - 'null' x-go-name: Source x-go-package: magneto/agents/windows/stub/ad_param.pb MongoDBAdditionalParams: description: 'Contains additional parameters required for taking backup from this Mongo cluster.' type: object properties: secondaryNodeTag: description: 'The tag associated with the secondary nodes from which backups should be performed.' type: - array - 'null' items: type: string x-go-name: SecondaryNodeTag useSecondaryForBackup: description: Set to true if this cluster uses secondary nodes for backup. type: - boolean - 'null' x-go-name: UseSecondaryForBackup x-go-package: magneto/base/nosql.pb RestoreTaskStateBaseProto: type: object properties: cancellationRequested: description: Whether this task has a pending cancellation request. type: - boolean - 'null' x-go-name: CancellationRequested endTimeUsecs: description: 'If the restore task has finished, this field contains the end time for the task.' type: - integer - 'null' format: int64 x-go-name: EndTimeUsecs error: description: 'The error encountered by task (if any). Only valid if the task has finished.' $ref: '#/components/schemas/ErrorProto' name: description: The name of the restore task. type: - string - 'null' x-go-name: Name parentSourceConnectionParams: description: A way to connect to the parent source. $ref: '#/components/schemas/ConnectorParams' publicStatus: description: Iris-facing task state. This field is stamped during the export. type: - integer - 'null' format: int32 x-go-name: PublicStatus refreshStatus: description: Status of the refresh task. type: - integer - 'null' format: int32 x-go-name: RefreshStatus restoreVlanParams: description: 'This contains restore vlan params if it was specified as part of the restore task.' $ref: '#/components/schemas/VlanParams' scheduledConstituentId: description: 'Constituent id (and the gandalf session id) where this task has been scheduled. If -1, the task is not running at any slave. It''s possible that the task was previously scheduled, but is now being re-scheduled.' type: - integer - 'null' format: int64 x-go-name: ScheduledConstituentId scheduledGandalfSessionId: type: - integer - 'null' format: int64 x-go-name: ScheduledGandalfSessionId startTimeUsecs: description: The start time for this restore task. type: - integer - 'null' format: int64 x-go-name: StartTimeUsecs status: description: Status of the restore task. type: - integer - 'null' format: int32 x-go-name: Status taskId: description: A globally unique id for this task. type: - integer - 'null' format: int64 x-go-name: TaskId totalLogicalSizeBytes: description: 'Logical size of this restore task. This is the amount of data that needs to be transferred to restore the entity.' type: - integer - 'null' format: int64 x-go-name: TotalLogicalSizeBytes totalPhysicalSizeBytes: description: 'Physical size of this restore task. This is the amount of data that was actually transferred to restore the entity.' type: - integer - 'null' format: int64 x-go-name: TotalPhysicalSizeBytes type: description: The type of restore being performed. type: - integer - 'null' format: int32 x-go-name: Type user: description: The user who requested this restore task. type: - string - 'null' x-go-name: User userInfo: description: Specifies information about the user who made the request. $ref: '#/components/schemas/UserInformation' userMessages: description: 'Messages displayed to the user for this task (if any). Only valid if the status of the task is kFinished. This is used for informing the user with additional details when there is not an error.' type: - array - 'null' items: type: string x-go-name: UserMessages warnings: description: The warnings encountered by this task (if any) during its execution. type: - array - 'null' items: $ref: '#/components/schemas/ErrorProto' x-go-name: Warnings x-go-package: magneto/master/base/master.pb DeployVMsToCloudParams: description: 'Contains Cloud specific information needed to identify various resources when deploying a VM to Cloud.' type: object properties: deployFleetParams: $ref: '#/components/schemas/DeployFleetParams' deployVmsToAwsParams: $ref: '#/components/schemas/DeployVMsToAWSParams' deployVmsToAzureParams: $ref: '#/components/schemas/DeployVMsToAzureParams' deployVmsToGcpParams: $ref: '#/components/schemas/DeployVMsToGCPParams' replicateSnapshotsToAwsParams: $ref: '#/components/schemas/ReplicateSnapshotsToAWSParams' replicateSnapshotsToAzureParams: $ref: '#/components/schemas/ReplicateSnapshotsToAzureParams' x-go-package: magneto/base/cloud_deploy.pb ObjectSnapshotType: type: object title: This message captures information about the snapshot type. properties: msg: description: 'This captures any additional message about the snapshot itself, e.g. if the app-consistent snapshot had to fallback to crash consistent, this will contain that.' type: - string - 'null' x-go-name: Msg type: type: - integer - 'null' format: int32 x-go-name: Type x-go-package: magneto/base/magneto.pb RetrieveArchiveInfo: description: 'Proto to describe information about the retrieval of an archive task as provided by Icebox.' type: object properties: avgLogicalTransferRateBps: description: Average logical bytes transfer rate in bytes per second as seen by Icebox. type: - integer - 'null' format: int64 x-go-name: AvgLogicalTransferRateBps bytesTransferred: description: Number of physical bytes transferred for this retrieval task so far. type: - integer - 'null' format: int64 x-go-name: BytesTransferred endTimeUsecs: description: 'Time when this retrieval task ended at Icebox side. If not set, then the retrieval has not ended yet.' type: - integer - 'null' format: int64 x-go-name: EndTimeUsecs error: description: 'If the retrieval task has completed, the following indicates whether there was an error in its completion.' $ref: '#/components/schemas/ErrorProto' logicalBytesTransferred: description: Number of logical bytes transferred so far. type: - integer - 'null' format: int64 x-go-name: LogicalBytesTransferred logicalSizeBytes: description: Total logical size of the retrieval task. type: - integer - 'null' format: int64 x-go-name: LogicalSizeBytes progressMonitorTaskPath: description: The root path of the progress monitor for this task. type: - string - 'null' x-go-name: ProgressMonitorTaskPath retrievedEntityVec: description: Contains info about all retrieved entities. type: - array - 'null' items: $ref: '#/components/schemas/RetrieveArchiveInfo_RetrievedEntity' x-go-name: RetrievedEntityVec startTimeUsecs: description: 'Time when this retrieval task was started by Icebox. If not set, then retrieval has not been started yet.' type: - integer - 'null' format: int64 x-go-name: StartTimeUsecs stubViewName: description: 'The stub view that Icebox created. Stub view can be used for selectively restoring or accessing files from an archive location.' type: - string - 'null' x-go-name: StubViewName stubViewRelativeDirName: description: Relative directory inside the stub view that corresponds with the archive. type: - string - 'null' x-go-name: StubViewRelativeDirName targetViewName: description: 'The name of the target view where Icebox has retrieved and staged the requested entities.' type: - string - 'null' x-go-name: TargetViewName userActionRequiredMsg: description: 'Message to display in the UI if any manual intervention is needed to make forward progress for the retrieve from archive task. This message is mainly relevant for tape based retrieve from archive tasks where a backup admin might be asked to load new media when the tape library does not have the relevant media to retrieve the archive from.' type: - string - 'null' x-go-name: UserActionRequiredMsg x-go-package: magneto/master/base/master.pb VlanParams: type: object title: Contains vlan params associated with the backup/restore operation. properties: disableVlan: description: 'If this is set to true, then even if VLANs are configured on the system, the partition VIPs will be used for the restore.' type: - boolean - 'null' x-go-name: DisableVlan interfaceName: description: 'Interface group to use for restore. If this is not specified, primary interface group for the cluster will be used.' type: - string - 'null' x-go-name: InterfaceName vlanId: description: 'If this is set, then the Cohesity host name or the IP address associated with this vlan is used for mounting Cohesity''s view on the remote host.' type: - integer - 'null' format: int32 x-go-name: VlanId x-go-package: magneto/base/common.pb IdpUserInfo: description: 'Specifies an IdP User''s information logged in using an IdP. This information is not stored on the Cluster.' type: object title: IdP User Information. properties: groups: description: 'Specifies the Idp groups that the user is part of. As the user may not be registered on the cluster, we may have to capture the idp group membership. This way, if a group is created on the cluster later, users will instantly have access to tenantIds from that group as well.' type: - array - 'null' items: type: string x-go-name: Groups idpId: description: Specifies the unique Id assigned by the Cluster for the IdP. type: - integer - 'null' format: int64 x-go-name: IdpId issuerId: description: Specifies the unique identifier assigned by the vendor for this Cluster. type: - string - 'null' x-go-name: IssuerId userId: description: Specifies the unique identifier assigned by the vendor for the user. type: - string - 'null' x-go-name: UserId vendor: description: Specifies the vendor providing the IdP service. type: - string - 'null' x-go-name: Vendor x-go-package: cohesity/iris/server/data/public ClusterConfigProto_Subnet: type: object title: The following message defines a subnet. properties: component: description: The component that has claimed this subnet. type: - integer - 'null' format: int32 x-go-name: Component description: description: Description of the subnet. type: - string - 'null' x-go-name: Description gateway: description: Gateway for the subnet. type: - string - 'null' x-go-name: Gateway id: description: ID for this subnet. type: - integer - 'null' format: int32 x-go-name: Id ip: description: 'ip is subnet IP address given either in v4 or v6. Netmask is specified by giving CIDR length in netmask_bits for ipv6. For IPv4 addresses, netmask_ip4 field is set in dotted decimal.' type: - string - 'null' x-go-name: Ip netmaskBits: type: - integer - 'null' format: int32 x-go-name: NetmaskBits netmaskIp4: type: - string - 'null' x-go-name: NetmaskIp4 nfsAccess: description: Whether clients from this subnet can mount using NFS protocol. type: - integer - 'null' format: int32 x-go-name: NfsAccess nfsAllSquash: description: 'Whether all clients from this subnet can map view with view_all_squash_uid/view_all_squash_gid configured in the view.' type: - boolean - 'null' x-go-name: NfsAllSquash nfsRootSquash: description: Whether clients from this subnet can mount as root on NFS. type: - boolean - 'null' x-go-name: NfsRootSquash smbAccess: description: Whether clients from this subnet can mount using SMB protocol. type: - integer - 'null' format: int32 x-go-name: SmbAccess x-go-package: configs/cluster_config.pb RestoreFilesInfoProto: description: 'Each available extension is listed below along with the location of the proto file (relative to magneto/connectors) where it is defined. RestoreFilesInfoProto extension Location Extn ============================================================================= vmware::RestoreFilesInfo::vmware_restore_files_info vmware/vmware.proto 100 AgentRestoreFilesInfo::agent_restore_files_info base/agent.proto 101 file::RestoreFilesInfo::restore_files_info file/file.proto 102 hyperv::RestoreFilesInfo::hyperv_restore_files_info hyperv/hyperv.proto 103 =============================================================================' type: object title: 'Message that encapsulates information about restore file tasks for any of the environments we support. Environment specific restore infos are defined as extensions to this proto.' properties: downloadFilesPath: description: 'The path that the user should use to download files through the UI. If only a single file needs to be downloaded, this will be the path to that file. If a directory or multiple files & directories need to be downloaded, this will be the path to the .zip file to download. Only applicable to a download files task.' type: - string - 'null' x-go-name: DownloadFilesPath error: description: 'If the restore files failed, this field may contain the cause of the failure.' $ref: '#/components/schemas/ErrorProto' proxyEntityConnectorParams: description: Contains the connector params of the proxy server if one was specified. $ref: '#/components/schemas/ConnectorParams' restoreFilesResultVec: description: Contains the result information of the restored files. type: - array - 'null' items: $ref: '#/components/schemas/RestoreFileResultInfo' x-go-name: RestoreFilesResultVec slaveTaskStartTimeUsecs: description: This is the timestamp at which the slave task started. type: - integer - 'null' format: int64 x-go-name: SlaveTaskStartTimeUsecs targetType: description: 'Specifies the target type for the task. The field is only valid if the task has got a permit.' type: - integer - 'null' format: int32 x-go-name: TargetType teardownError: description: 'If an error was encountered during teardown of the setup (for ex: unmounting the datastore from the host), then this field will contain the cause of the failure.' $ref: '#/components/schemas/ErrorProto' type: description: The type of environment this restore files info pertains to. type: - integer - 'null' format: int32 x-go-name: Type x-go-package: magneto/base/magneto.pb CompareADObjectsResult_ADAttribute: type: object title: Represents an AD attribute(property). properties: attrFlags: description: Object result flags of type ADAttributeFlags. type: - integer - 'null' format: uint32 x-go-name: AttrFlags destValue: description: 'Destination attribute value if dest value exists (!ADAttributeFlags.kNotFound) and is different from source.' $ref: '#/components/schemas/CompareADObjectsResult_ADAttributeValue' ldapName: description: LDAP attribute name. type: - string - 'null' x-go-name: LdapName sameValue: description: 'if the attribute values are same (ADAttributeFlags.kEqual), the value is put here to avoid duplication in ''source_value'' and ''dest_value''.' $ref: '#/components/schemas/CompareADObjectsResult_ADAttributeValue' sourceValue: description: 'Source attribute value if source value exists (!ADAttributeFlags.kNotFound) and is different from destination.' $ref: '#/components/schemas/CompareADObjectsResult_ADAttributeValue' status: description: Error status for the attribute compare or value access. $ref: '#/components/schemas/ErrorProto' x-go-package: magneto/agents/windows/stub/ad_param.pb OwnerInfo: type: object title: Information about a resource (i.e., bucket or object) owner. properties: userId: description: Unique identifier of the owner. type: - string - 'null' x-go-name: UserId x-go-package: bridge/s3_portal/base/s3_metadata.pb FilteringPolicyProto: description: 'Proto to encapsulate the filtering policy for backup objects like files or directories. If an object is not matched by any of the ''allow_filters'', it will be excluded in the backup. If an object is matched by one of the ''deny_filters'', it will always be excluded in the backup. Basically ''deny_filters'' overwrite ''allow_filters'' if they both match the same object. Currently we only support two kinds of filter: prefix which always starts with ''/'', or postfix which always starts with ''*'' (cannot be "*" only). We don''t support regular expression right now. A concrete example is: Allow filters: "/" Deny filters: "/tmp", "*.mp4" Using such a policy will include everything under the root directory except the /tmp directory and all the mp4 files.' type: object title: Filtering Policy Proto. properties: allowFilters: description: List of filters to allow matched objects for backup. type: - array - 'null' items: type: string x-go-name: AllowFilters denyFilters: description: List of filters to deny matched objects for backup. type: - array - 'null' items: type: string x-go-name: DenyFilters x-go-package: magneto/base/env_params.pb RestoreSqlAppObjectParams: type: object title: The application object restore params for SQL objects (SQL databases). properties: captureTailLogs: description: 'Set to true if tail logs are to be captured before the restore operation. This is only applicable if we are restoring the SQL database to its original source, and the database is not being renamed.' type: - boolean - 'null' x-go-name: CaptureTailLogs continueAfterError: description: Whether restore should continue after encountering a page checksum error. type: - boolean - 'null' x-go-name: ContinueAfterError dataFileDestination: description: 'Which directory to put the database data files. Missing directory will be automatically created. Cannot be empty if not restoring to the original SQL instance.' type: - string - 'null' x-go-name: DataFileDestination dbRestoreOverwritePolicy: description: Policy to overwrite an existing DB during a restore operation. type: - integer - 'null' format: int32 x-go-name: DbRestoreOverwritePolicy enableChecksum: description: Whether restore checksums are enabled. type: - boolean - 'null' x-go-name: EnableChecksum instanceName: description: 'The name of the SQL instance that we restore database to. If target_host is not empty, this also cannot be empty.' type: - string - 'null' x-go-name: InstanceName isAutoSyncEnabled: description: 'The following field is set if auto_sync for multi-stage SQL restore task is enabled. This field is valid only if is_multi_state_restore is set to true.' type: - boolean - 'null' x-go-name: IsAutoSyncEnabled isMultiStageRestore: description: 'The following field is set if we are creating a multi-stage SQL restore task needed for features such as Hot-Standby.' type: - boolean - 'null' x-go-name: IsMultiStageRestore keepCdc: description: Set to true to keep cdc on restored database. type: - boolean - 'null' x-go-name: KeepCdc logFileDestination: description: 'Which directory to put the database log files. Missing directory will be automatically created. Cannot be empty if not restoring to the original SQL instance.' type: - string - 'null' x-go-name: LogFileDestination multiStageRestoreOptions: description: 'Note that this field is set internally by Magneto, and should not be set by Iris.' title: 'The following field is set if this is a sub task for a multi-stage SQL restore task. It captures the options specified for this sub-task.' $ref: '#/components/schemas/SqlUpdateRestoreTaskOptions' newDatabaseName: description: 'The new name of the database, if it is going to be renamed. app_entity in RestoreAppObject has to be non-empty for the renaming, otherwise it does not make sense to rename all databases in the owner.' type: - string - 'null' x-go-name: NewDatabaseName restoreTimeSecs: description: 'The time to which the SQL database needs to be restored. This allows for granular recovery of SQL databases. If this is not set, the SQL database will be recovered to the full/incremental snapshot (specified in the owner''s restore object in AppOwnerRestoreInfo).' type: - integer - 'null' format: int64 x-go-name: RestoreTimeSecs resumeRestore: description: 'Resume restore if sql instance/database exist in restore/recovering state. The database might be in restore/recovering state if previous restore failed or previous restore was attempted with norecovery option.' type: - boolean - 'null' x-go-name: ResumeRestore secondaryDataFileDestination: description: 'Which directory to put the secondary data files of the database. Secondary data files are optional and are user defined. The recommended file name extension for these is ".ndf". If this option is specified, the directory will be automatically created if its missing.' type: - string - 'null' x-go-name: SecondaryDataFileDestination secondaryDataFileDestinationVec: description: 'Specify the secondary data files and corresponding direcories of the DB. Secondary data files are optional and are user defined. The recommended file extension for secondary files is ".ndf". If this option is specified and the destination folders do not exist they will be automatically created.' type: - array - 'null' items: $ref: '#/components/schemas/FilesToDirectoryMapping' x-go-name: SecondaryDataFileDestinationVec withClause: description: '''with_clause'' contains ''with clause'' to be used in native sql restore command. This is only applicable for db restore of native sql backup. Here user can specify multiple restore options. Example: "WITH BUFFERCOUNT = 575, MAXTRANSFERSIZE = 2097152". If this is not specified, we use the value specified in magneto_sql_native_restore_with_clause gflag.' type: - string - 'null' x-go-name: WithClause withNoRecovery: description: 'Set to true if we want to recover the database in "NO_RECOVERY" mode which does not bring it online after restore.' type: - boolean - 'null' x-go-name: WithNoRecovery x-go-package: magneto/base/magneto.pb HBaseRecoverJobParams: description: 'Contains any additional hbase environment specific params for the recover job.' type: object properties: hdfsConnectParams: description: Additional hdfs connection params required for HBase Backup. $ref: '#/components/schemas/HdfsConnectParams' suffix: description: A suffix that is to be applied to all recovered entities type: - string - 'null' x-go-name: Suffix x-go-package: magneto/base/nosql.pb Value_Data: description: 'Specifies the fields to store data of a given type. Specify data in the appropriate field for the current data type.' type: object title: Data. properties: bytesValue: description: 'Specifies the field to store an array of bytes if the current data type is bytes. Specify a value for this field when type is equal to 4.' type: - array - 'null' items: type: integer format: uint8 x-go-name: BytesValue doubleValue: description: 'Specifies the field to store data if the current data type is a double value. Specify a value for this field when type is equal to 2.' type: - number - 'null' format: double x-go-name: DoubleValue int64Value: description: 'Specifies the field to store data if the current data type is a int64 value. Specify a value for this field when type is equal to 1.' type: - integer - 'null' format: int64 x-go-name: Int64Value stringValue: description: 'Specifies the field to store data if the current data type is a string value. Specify a value for this field when type is equal to 3.' type: - string - 'null' x-go-name: StringValue x-go-package: stats/base/stats_types.pb DestroyClonedEntityInfoProto_ClonedEntity: type: object properties: entity: description: 'Proto of the entity created by the clone operation. This field might be empty if the clone operation failed. If so, destroy task will make the best effort to cleanup this failed cloned entity (i.e, delete the files referred by ''relative_restore_path_vec'' from the view).' $ref: '#/components/schemas/EntityProto' relativeRestorePathVec: description: 'Path of all files created by the clone operation. Each path is relative to the clone view.' type: - array - 'null' items: type: string x-go-name: RelativeRestorePathVec x-go-package: magneto/base/magneto.pb RestoredFileInfo: type: object title: This message has information on file/directory being restored. properties: absolutePath: description: 'Full path of the file being restored: the actual file path without the disk. E.g.: \Program Files\App\file.txt' type: - string - 'null' x-go-name: AbsolutePath attachedDiskId: description: Disk information of where the source file is currently located. type: - integer - 'null' format: int32 x-go-name: AttachedDiskId diskPartitionId: description: Disk partition to which the file belongs to. type: - integer - 'null' format: int32 x-go-name: DiskPartitionId fsUuid: description: File system UUID on which file resides. type: - string - 'null' x-go-name: FsUuid inodeNumber: description: 'Inode number of the file. This is needed for snapmirror restore workflow.' type: - integer - 'null' format: int64 x-go-name: InodeNumber isDirectory: description: Whether the path points to a directory. type: - boolean - 'null' x-go-name: IsDirectory isNonSimpleLdmVol: description: 'This will be set to true for recovery workflows for non-simple volumes on Windows Dynamic Disks. In that case, we will use VolumeInfo instead of some of the details captured here (e.g. virtual_disk_file) for determining disk and volume related details.' type: - boolean - 'null' x-go-name: IsNonSimpleLdmVol restoreBaseDirectory: description: 'This must be set to a directory path if restore_to_original_paths is false and restore task has multiple files which are not desired to be restore to one common location. If this filed is populated, ''absolute_path'' will be restored under this location. If this field is not populated all files in restore task will be restored to location specified in RestoreFilesPreferences.' type: - string - 'null' x-go-name: RestoreBaseDirectory restoreMountPoint: description: 'Mount point of the volume on which the file to be restored is located. E.g.: c:\temp\vhd_mount_1234' type: - string - 'null' x-go-name: RestoreMountPoint sizeBytes: description: Size of the file in bytes. Required in FLR in GCP using Cloud Functions. type: - integer - 'null' format: int64 x-go-name: SizeBytes virtualDiskFile: description: Virtual disk file to which this file belongs to. type: - string - 'null' x-go-name: VirtualDiskFile volumeId: description: Id of the volume. type: - string - 'null' x-go-name: VolumeId volumePath: description: 'Original volume name (or drive letter). This is used while performing the copy to the original paths. E.g.: c:' type: - string - 'null' x-go-name: VolumePath x-go-package: magneto/base/magneto.pb RestoreOracleAppObjectParams: type: object title: The application object restore params for Oracle objects (Oracle databases). properties: alternateLocationParams: $ref: '#/components/schemas/RestoreOracleAppObjectParams_AlternateLocationParams' noOpenMode: description: If set to true, the recovered database will not be opened. type: - boolean - 'null' x-go-name: NoOpenMode oracleCloneAppViewParamsVec: description: 'Following field contains information related to view expose workflow. Ex mountpoint identifier specified by User from UI.' type: - array - 'null' items: $ref: '#/components/schemas/CloneAppViewParams' x-go-name: OracleCloneAppViewParamsVec oracleTargetParams: description: 'Contains information regarding oracle sources, channel information and host nomination details.' $ref: '#/components/schemas/OracleSourceParams' parallelOpEnabled: description: If set to true, parallel backups/restores/clones are enabled on same host. type: - boolean - 'null' x-go-name: ParallelOpEnabled restoreTimeSecs: description: 'The time to which the Oracle database needs to be restored. This allows for granular recovery of Oracle databases. If this is not set, the Oracle database will be recovered to the full/incremental snapshot (specified in the owner''s restore object in AppOwnerRestoreInfo). This is only applicable if restoring to the original Oracle instance.' type: - integer - 'null' format: int64 x-go-name: RestoreTimeSecs shellEnvironmentVec: type: - array - 'null' items: $ref: '#/components/schemas/RestoreOracleAppObjectParams_KeyValuePair' x-go-name: ShellEnvironmentVec x-go-package: magneto/base/magneto.pb AwsParams: description: Specifies various resources when converting and deploying a VM to AWS. type: object title: AWS Parameters. properties: instanceId: description: Specifies id of the AWS instance type in which to deploy the VM. type: - integer - 'null' format: int64 x-go-name: InstanceId networkSecurityGroupIds: description: Specifies ids of the network security groups within above VPC. type: - array - 'null' items: type: integer format: int64 x-go-name: NetworkSecurityGroupIds rdsParams: description: Specifies Amazon RDS parameters. $ref: '#/components/schemas/RdsParams' region: description: Specifies id of the AWS region in which to deploy the VM. type: - integer - 'null' format: int64 x-go-name: Region subnetId: description: Specifies id of the subnet within above VPC. type: - integer - 'null' format: int64 x-go-name: SubnetId virtualPrivateCloudId: description: Specifies id of the Virtual Private Cloud to chose for the instance type. type: - integer - 'null' format: int64 x-go-name: VirtualPrivateCloudId x-go-package: cohesity/iris/server/data/public ConnectorParams: description: 'Message that encapsulates the various params required to establish a connection with a particular environment.' type: object properties: additionalParams: description: 'Optional additional connector params might be needed to connect to an environment.' $ref: '#/components/schemas/AdditionalConnectorParams' agentEndpoint: description: 'For some of the environments connection to endpoint is done through an agent. This captures the agent endpoint information.' type: - string - 'null' x-go-name: AgentEndpoint agentPort: description: 'Optional agent port to use when connecting to the server. If this is not specified, then environment specific default port will be used.' type: - integer - 'null' format: int32 x-go-name: AgentPort credentials: description: Credentials that will be used to login to the environment. $ref: '#/components/schemas/Credentials' endpoint: description: 'The endpoint URL of the environment (such as the address of the vCenter instance for a VMware environment, etc).' type: - string - 'null' x-go-name: Endpoint entity: description: 'Optionally the entity associated with the endpoint can be passed. Information within the entity could be used in creation of an appropriate connector context.' $ref: '#/components/schemas/EntityProto' hostType: description: The host environment type. This is set for kPhysical type environment. type: - integer - 'null' format: int32 x-go-name: HostType id: description: 'A unique id associated with this connector params. This is a convenience field and is used to maintain an index to different connection params. This is generated at the time when the source is registered with Magneto.' type: - integer - 'null' format: int64 x-go-name: Id populateSubnetForAllClusterNodes: description: 'If set to true, inter agent communcation will be enabled and for every GetAgentInfo call we will fill subnet information of all the nodes in clustered entity.' type: - boolean - 'null' x-go-name: PopulateSubnetForAllClusterNodes port: description: 'Optional port to use when connecting to the server. If this is not specified, then environment specific default port will be used.' type: - integer - 'null' format: int32 x-go-name: Port tenantId: description: 'The tenant_id for the environment. This is used to remotely access connectors and executors via bifrost.' type: - string - 'null' x-go-name: TenantId type: description: The type of environment to connect to. type: - integer - 'null' format: int32 x-go-name: Type version: description: 'A version that is associated with the params. This is updated anytime any of the params change. This is used to discard older connector params.' type: - integer - 'null' format: int64 x-go-name: Version x-go-package: magneto/base/magneto.pb RequestError: description: Details about the Error. type: object title: Error properties: errorCode: description: Operation response error code. type: - integer - 'null' format: int64 x-go-name: ErrorCode message: description: Description of the error. type: - string - 'null' x-go-name: Message x-go-package: cohesity/iris/server/data/public KeystoneACLProto_Grantees_ProjectUsers: type: object properties: userIdVec: type: - array - 'null' items: type: string x-go-name: UserIdVec x-go-package: bridge/s3_portal/base/s3_metadata.pb AWSFleetParams_NetworkParams: type: object title: Network params for a VM. properties: region: description: Region for the VM. type: - string - 'null' x-go-name: Region subnet: description: Subnet for the VM. type: - string - 'null' x-go-name: Subnet vpc: description: VPC for the VM. type: - string - 'null' x-go-name: Vpc x-go-package: magneto/base/entities/aws.pb MongoDBConnectParams: description: 'Specifies an Object containing information about a registered mongodb source.' type: object title: MongoDB Connect Params. properties: authType: description: 'Specifies whether authentication is configured on this MongoDB cluster. Specifies the type of an MongoDB source entity. ''SCRAM'' ''LDAP'' ''NONE''' type: - string - 'null' enum: - SCRAM - LDAP - NONE x-go-name: AuthType authenticatingDatabaseName: description: Specifies the Authenticating Database for this MongoDB cluster. type: - string - 'null' x-go-name: AuthenticatingDatabaseName requiresSsl: description: Specifies whether connection is allowed through SSL only in this cluster. type: - boolean - 'null' x-go-name: RequiresSsl secondaryNodeTag: description: 'MongoDB Secondary node tag. Required only if ''useSecondaryForBackup'' is true. The system will use this to identify the secondary nodes for reading backup data.' type: - string - 'null' x-go-name: SecondaryNodeTag seeds: description: Specifies the seeds of this MongoDB Cluster. type: - array - 'null' items: type: string x-go-name: Seeds useSecondaryForBackup: description: Set this to true if you want the system to peform backups from secondary nodes. type: - boolean - 'null' x-go-name: UseSecondaryForBackup x-go-package: cohesity/iris/server/data/public VaultParams_RestoreParams: type: object title: Params for initiate restore. properties: glacier: $ref: '#/components/schemas/VaultParams_RestoreParams_Glacier' x-go-package: bridge/vault/base/vault.pb PerformRestoreTaskStateProto: type: object properties: actionExecutorTargetType: description: 'Denotes the target for action executor(Bridge / BridgeProxy) on which task on slave should execute actions.' type: - integer - 'null' format: int32 x-go-name: ActionExecutorTargetType base: description: Contains basic information about the restore task. $ref: '#/components/schemas/RestoreTaskStateBaseProto' canTeardown: description: 'This is set if the clone operation has created any objects on the primary environment and teardown operation is possible. UI will disable the teardown button only if this is not set or set to false. NOTE: This won''t be reset if the teardown operation subsequently completes as teardown state is managed separately.' type: - boolean - 'null' x-go-name: CanTeardown cdpRestoreProgressMonitorTaskPath: description: 'The path of the progress monitor for the task that is responsible for creating the CDP hydrated view.' type: - string - 'null' x-go-name: CdpRestoreProgressMonitorTaskPath cdpRestoreTask: description: 'The CDP restore helper task which creates the hydrated views for the other restores.' $ref: '#/components/schemas/PerformRestoreTaskStateProto' cdpRestoreTaskId: description: The id of the task that will create the CDP hydrated view. type: - integer - 'null' format: int64 x-go-name: CdpRestoreTaskId cdpRestoreViewName: description: The temporary view where the hydrated disks of the CDP restores are kept. type: - string - 'null' x-go-name: CdpRestoreViewName childCloneTaskId: description: The id of the child clone task triggered by refresh op. type: - integer - 'null' format: int64 x-go-name: ChildCloneTaskId childDestroyTaskId: description: 'The following fields are used by clone refresh op. These will be present only in case of refresh task op. The id of the child destroy clone task triggered by refresh op.' type: - integer - 'null' format: int64 x-go-name: ChildDestroyTaskId cloneAppViewInfo: description: 'The information about cloned backup view of an App [ ex. Oracle,SQL]. Currently this only contains the clone view information for Oracle, which contains the vector of mount-paths where the cloned view got mounted on the Oracle Host.' $ref: '#/components/schemas/CloneAppViewInfoProto' cloudDeployInfo: description: 'This is set only when the restore task is of type kDeployVMs. It contains information about the kDeployVMs restore task that is populated by the slave.' $ref: '#/components/schemas/CloudDeployInfoProto' continueRestoreOnError: description: 'Whether to continue with the restore operation if restore of any object fails.' type: - boolean - 'null' x-go-name: ContinueRestoreOnError createView: description: True iff the target view needs to be created. type: - boolean - 'null' x-go-name: CreateView datastoreEntityVec: description: 'Please refer to comments for the field CreateRestoreTaskArg.datastore_entity_vec for more details.' type: - array - 'null' items: $ref: '#/components/schemas/EntityProto' x-go-name: DatastoreEntityVec deployVmsToCloudTaskState: description: 'This contains information regarding deploy vm to cloud task state. This is set for restore type kConvertAndDeployVMs.' $ref: '#/components/schemas/DeployVMsToCloudTaskStateProto' folderEntity: description: 'Semantics for a restore task of type kCloneVMs: For a successful restore task, it will be always set. For a failed task, it may or may not be set. Semantics for a restore task of type kRecoverVMs: Folder entity will be set only if objects were restored to a different source.' title: An optional folder entity where the restored objects are placed. $ref: '#/components/schemas/EntityProto' fullViewName: description: 'The full view name (internal or external). This is composed of an optional Cohesity specific prefix and the user provided view name.' type: - string - 'null' x-go-name: FullViewName includeVmConfig: description: 'This is set to true if the vm-config.xml need to be copied in the target view/folder.' type: - boolean - 'null' x-go-name: IncludeVmConfig mountVolumesTaskState: description: 'This contains information regarding mount volumes task state. This is set for restore type kMountVolumes.' $ref: '#/components/schemas/MountVolumesTaskStateProto' nosqlConnectParams: description: Parameters to connect to destination nosql parent entity. $ref: '#/components/schemas/NoSqlConnectParams' nosqlRecoverJobParams: description: Additional parameters for the recovery job to send to imanis server. $ref: '#/components/schemas/NoSqlRecoverJobParams' objectName_DEPRECATED: description: An optional name to give to the restored object. type: - string - 'null' x-go-name: ObjectName_DEPRECATED objects: description: 'Information on the exact set of objects being restored (along with snapshots they are being recovered from). Even if the user wanted to restore an entire job from the latest snapshot, this will have individual objects and the exact snapshot they are being restored from. If specified, this can only have leaf-level entities.' type: - array - 'null' items: $ref: '#/components/schemas/RestoreObject' x-go-name: Objects objectsProgressMonitorTaskPaths: description: 'Vector containing the relative task path of progress monitors of the objects in the above field ''objects'' to be restored. There is one to one correspondence between elements in ''objects'' and ''objects_progress_monitor_task_paths''. Please note that this field will be set only after progress monitor is created for this restore task.' type: - array - 'null' items: type: string x-go-name: ObjectsProgressMonitorTaskPaths parentRestoreJobId: description: 'If this a child restore task, this field will contain the id of the parent restore job that spawned this task. List of env and action type for which this field is applicable are: Acropolis: kRecoverVMs.' type: - integer - 'null' format: int64 x-go-name: ParentRestoreJobId parentRestoreTaskId: description: 'The id of the parent restore task if this is a restore sub-task. List of environments that use this field: kSQL : Used for multi-stage SQL restore that supports a hot-standy. This will also be used by refresh op to mark the new clone as internal sub-task.' type: - integer - 'null' format: int64 x-go-name: ParentRestoreTaskId pathPrefix_DEPRECATED: type: - string - 'null' x-go-name: PathPrefix_DEPRECATED physicalFlrParallelRestore: description: 'If enabled, magneto physical file restore will be enabled via job framework' type: - boolean - 'null' x-go-name: PhysicalFlrParallelRestore physicalFlrUseNewLockingMethod: description: 'If enabled, magneto physical file restore will be enabled via job framework' type: - boolean - 'null' x-go-name: PhysicalFlrUseNewLockingMethod powerStateConfig: description: 'The power state configuration to be applied to the restored object. Please refer to comments for the field CreateRestoreTaskArg.power_state_config for more details.' $ref: '#/components/schemas/PowerStateConfigProto' preserveTags: description: This field is currently used by HyperV and VMWare. type: - boolean - 'null' x-go-name: PreserveTags progressMonitorTaskPath: description: Root path of a Pulse task tracking the progress of the restore task. type: - string - 'null' x-go-name: ProgressMonitorTaskPath recoverDisksTaskState: description: 'Contains information pertinent to a virtual disk recovery task. This is set for restore type kRecoverDisks.' $ref: '#/components/schemas/RecoverDisksTaskStateProto' recoverVolumesTaskState: description: 'Contains information pertinent to a volume recovery task. This is set for restore type kRecoverVolumes.' $ref: '#/components/schemas/RecoverVolumesTaskStateProto' relatedRestoreTaskId: description: 'The task id of a related restore task. For example, a SQL restore operation may involve restoring a VM first and then restoring SQL databases after that. So the corresponding VM restore and SQL database restore tasks will be related, and they will each have their ''related_restore_task_id'' set to the id of the other task.' type: - integer - 'null' format: int64 x-go-name: RelatedRestoreTaskId renameRestoredObjectParam: description: 'An optional parameter to specify how restored objects are renamed. Please refer to comments for the field CreateRestoreTaskArg.rename_restored_object_param for more details.' $ref: '#/components/schemas/RenameObjectParamProto' renameRestoredVappParam: description: 'An optional parameter to specify how restored vApps(kVirtualApp) are renamed. Please refer to comments for the field CreateRestoreTaskArg.rename_restored_vapp_param for more details.' $ref: '#/components/schemas/RenameObjectParamProto' resourcePoolEntity: description: 'The resource pool entity where the restored objects will be attached. Please refer to comments for the field CreateRestoreTaskArg.resource_pool_entity for more details.' $ref: '#/components/schemas/EntityProto' restoreAcropolisVmsParams: description: 'This field defines the Acropolis specific params for restore task of type kRecoverVMs.' $ref: '#/components/schemas/RestoreAcropolisVMsParams' restoreAppTaskState: description: 'This contains information about application restore task state. This is set for restore types kRecoverApp/kCloneApp/kCloneRefreshApp.' $ref: '#/components/schemas/RestoreAppTaskStateProto' restoreFilesTaskState: description: 'This contains information regarding restore files task state. This is set for restore type kRestoreFiles and kDownloadFiles.' $ref: '#/components/schemas/RestoreFilesTaskStateProto' restoreHypervVmParams: description: 'This field defines the HyperV specific params for restore tasks of type kCloneVMs and kRecoverVMs.' $ref: '#/components/schemas/RestoreHyperVVMParams' restoreInfo: description: 'Contains information about this restore task that is populated by the slave.' $ref: '#/components/schemas/RestoreInfoProto' restoreKubernetesNamespacesParams: description: 'This field defines the Kubernetes specific params for restore task of type kRecoverNamespaces.' $ref: '#/components/schemas/RestoreKubernetesNamespacesParams' restoreKvmVmsParams: description: 'This field defines the KVM specific params for restore task of type kRecoverVMs.' $ref: '#/components/schemas/RestoreKVMVMsParams' restoreOneDriveParams: description: 'This field defines the one drive specific params for restore task of type kRecoverO365Drive.' $ref: '#/components/schemas/RestoreOneDriveParams' restoreOutlookParams: description: 'This field defines the O365 specific params for restore task of type kRecoverEmails.' $ref: '#/components/schemas/RestoreOutlookParams' restoreParentSource: description: 'An optional registered parent source to which objects are to be restored. If not specified, objects are restored back to the original source that was managing the objects. If ''restored_to_different_source'' is set to true, then this field must be specified.' $ref: '#/components/schemas/EntityProto' restorePublicFoldersParams: description: 'This field defines the O365 Public Folders specific params for restore task of type kRecoverO365PublicFolders.' $ref: '#/components/schemas/RestoreO365PublicFoldersParams' restoreSiteParams: description: 'This field defines the O365 site specific params for restore task of type kRecoverSites.' $ref: '#/components/schemas/RestoreSiteParams' restoreSubTaskVec: description: 'Inside Magneto, these are represented as regular restore tasks with their own PerformRestoreTaskStateProto. Each restore sub-task will have its parent_restore_task_id field set. List of environments that use this field: kSQL : Used for multi-stage SQL restore that supports a hot-standy.' type: - array - 'null' items: type: integer format: int64 x-go-name: RestoreSubTaskVec restoreTaskPurged: description: 'Whether the restore task is purged. During WAL recovery, purged restore tasks are ignored.' type: - boolean - 'null' x-go-name: RestoreTaskPurged restoreViewDatastoreEntity: description: 'Please note that this field will be set only for the restore task of type kCloneVMs.' title: 'The datastore entity where the object''s files are restored to. This entity corresponds to the datastore created for the Cohesity view on the primary source by the restore task.' $ref: '#/components/schemas/EntityProto' restoreVmwareVmParams: description: 'This field defines the VMware specific params for restore tasks of type kCloneVMs and kRecoverVMs.' $ref: '#/components/schemas/RestoreVMwareVMParams' restoredObjectsNetworkConfig: description: 'The network configuration to be applied to the restored object. Please refer to comments for the field CreateRestoreTaskArg.restored_objects_network_config for more details.' $ref: '#/components/schemas/RestoredObjectNetworkConfigProto' restoredToDifferentSource: description: Whether restore is being performed to a different parent source. type: - boolean - 'null' x-go-name: RestoredToDifferentSource retrieveArchiveProgressMonitorTaskPath: description: 'The path of the progress monitor for the task that is responsible for retrieving the objects from the archive.' type: - string - 'null' x-go-name: RetrieveArchiveProgressMonitorTaskPath retrieveArchiveStubViewName: description: 'The stub view created by Icebox corresponding to the archive. The stub view is used to selectively retrieve files and folders.' type: - string - 'null' x-go-name: RetrieveArchiveStubViewName retrieveArchiveTaskUidVec: description: 'The uid of the tasks that will retrieve the objects from the archive. Typically we only retrieve one snapshot for an enity but for point in time restores for SQL/Oracle database, we may need to retrieve multiple snapshots typically one full, and few logs. Hence we may need multiple uids to start retrieval task.' type: - array - 'null' items: $ref: '#/components/schemas/UniversalIdProto' x-go-name: RetrieveArchiveTaskUidVec retrieveArchiveTaskVec: description: 'Proto that contains all the information about the retrieve archive task. Typically we only retrieve one snapshot for an enity but for point in time restores for SQL/Oracle database, we may need to retrieve multiple snapshots typically one full, and few logs. As we may start the multiple retrieval tasks, we need vector of RetrieveArchiveTaskStateProto for storing information of retrieved archive tasks.' type: - array - 'null' items: $ref: '#/components/schemas/RetrieveArchiveTaskStateProto' x-go-name: RetrieveArchiveTaskVec retrieveArchiveViewName: description: 'The temporary view where the entities that have been retrieved from an archive have been placed in by Icebox.' type: - string - 'null' x-go-name: RetrieveArchiveViewName selectedDatastoreIdx: description: 'In case of restore job with multi-vm multi-datastore this field denotes the specific datastore index in datastore_entity_vec to be selected for the task. Not going for specific datastore allocation in datastore_entity_vec so that we have required information in case of extensibility for task level retries with different datastore' type: - integer - 'null' format: int64 x-go-name: SelectedDatastoreIdx stubViewRelativeDirName: description: Relative directory inside the stub view that corresponds with the archive. type: - string - 'null' x-go-name: StubViewRelativeDirName vaultRestoreParams: description: Params to be passed to Icebox while restoring data from an archive. $ref: '#/components/schemas/VaultParams_RestoreParams' vcdConfig: description: VApp config for the restored object. $ref: '#/components/schemas/RestoredObjectVCDConfigProto' vcdStorageProfileDatastoreMorefVec: description: 'This field is applicable for VCD type recovery. It defines the compatible datastores for recovery to alternate location. This field is inferred using the storage profile in restore_vmware_vm_params below.' type: - array - 'null' items: type: string x-go-name: VcdStorageProfileDatastoreMorefVec viewBoxId: description: 'The view box id to which ''view_name'' belongs to. In case the restore task corresponds to a backup job, this view box corresponds to the view box of the backup job.' type: - integer - 'null' format: int64 x-go-name: ViewBoxId viewName_DEPRECATED: description: The view name as provided by the user for this restore operation. type: - string - 'null' x-go-name: ViewName_DEPRECATED viewParams: description: The params to use when cloning the view. $ref: '#/components/schemas/ViewParams' volumeInfoVec: description: 'Information regarding volumes that are required for the restore task. This is populated for restore files and mount virtual disk ops.' type: - array - 'null' items: $ref: '#/components/schemas/VolumeInfo' x-go-name: VolumeInfoVec x-go-package: magneto/master/base/master.pb RestoreOneDriveParams: type: object title: This message defines the OneDrive specific restore params. properties: driveOwnerVec: description: The list of users/groups whose drives are being restored. type: - array - 'null' items: $ref: '#/components/schemas/RestoreOneDriveParams_DriveOwner' x-go-name: DriveOwnerVec restoreToOriginal: description: Whether or not all drive items are restored to original location. type: - boolean - 'null' x-go-name: RestoreToOriginal targetDriveId: description: The id of the drive in which items will be restored. type: - string - 'null' x-go-name: TargetDriveId targetFolderPath: description: 'All drives part of various users listed in drive_owner_vec will be restored to the drive belonging to target_user having id target_drive_id. Let''s say drive_owner_vec is A and B; drive_vec of A and B is 111 and 222 respectively; target_user is C; target_drive_id is 333. The final folder-hierarchy after restore job is finished will look like this : C:333: {target_folder_path}/| |A/111/{whatever is there in restore_item_vec of 111} |B/222/{whatever is there in restore_item_vec of 222}' type: - string - 'null' x-go-name: TargetFolderPath targetUser: description: This is the user in whose drive the items will be restored. $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/magneto.pb RestoreExchangeParams_ViewOptions: type: object properties: mountPoint: description: The path to access the SMB share. type: - string - 'null' x-go-name: MountPoint viewName: description: View to which the files of an Exchange database have to be cloned. type: - string - 'null' x-go-name: ViewName whitelistRestoreViewForAll: description: 'If set to true then when restore view is cloned then white-list all IPs not just the agent IP.' type: - boolean - 'null' x-go-name: WhitelistRestoreViewForAll x-go-package: magneto/base/magneto.pb RecoverVirtualDiskParams_VirtualDiskMapping: type: object title: Represents a single source/destination pair for the block-based restore. properties: diskToOverwrite: description: 'If the user is overwriting a destination disk, then this will capture the target disk info. NOTE: If this is specified, then power_off_vm_before_recovery must be true.' $ref: '#/components/schemas/VirtualDiskId' srcDisk: description: The source disk information. $ref: '#/components/schemas/VirtualDiskId' targetLocation: description: 'This contains the target location information, for e.g. a datastore in VMware environment. NOTE: If disk_to_overwrite is specified then the target location is automatically deduced, if not this must be specified.' $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/magneto.pb MountVolumesTaskStateProto: type: object title: Persistent state for a "mount volumes" restore task. properties: fullNasPath: description: 'Contains the SMB/NFS path of the share we expose to clients. The share contains the files pertinent to the original backup run type.' type: - string - 'null' x-go-name: FullNasPath hostEntity: description: 'The host on which the VM where the disks are attached to are running. NOTE: This is only used in HyperV environment.' $ref: '#/components/schemas/EntityProto' mountInfo: description: 'Contains information about the mount virtual disks task that is populated by the slave.' $ref: '#/components/schemas/MountVolumesInfoProto' mountParams: description: 'This captures all the necessary information required to perform mount virtual disks task.' $ref: '#/components/schemas/MountVolumesParams' x-go-package: magneto/master/base/master.pb RetrieveArchiveTaskStateProto_DownloadFilesInfo: description: 'Information required for Icebox when downloading files from an archived entity. This proto is specifically just for the current temporary solution for downloading a single from an archive, where we let icebox download the file for us. In the future once the new Yoda APIs for downloading files from archive stub views are ready, we will just discard this proto and make field 20 reserved.' type: object properties: filePathVec: description: 'The file paths to be retrieved from the archive. For example, if the file paths are /foo/bar and /foo2/bar and target_dir_path is "downloaded_files". The retrieved files will have the full path structure maintained in target_dir_path such as downloaded_files/foo/bar and /downloaded_files/foo2/bar.' type: - array - 'null' items: type: string x-go-name: FilePathVec magnetoInstanceId: description: Instance from which the requested files will be restored. $ref: '#/components/schemas/MagnetoInstanceId' objectId: description: Object from which the requested files will be restored. $ref: '#/components/schemas/MagnetoObjectId' skipRestoreInStubView: description: 'Ask Icebox to only create the stub view and skip restoring files in the stub view.' type: - boolean - 'null' x-go-name: SkipRestoreInStubView targetDirPath: description: Path to the directory under which the downloaded files will be placed. type: - string - 'null' x-go-name: TargetDirPath targetViewName: description: Target view name where the downloaded files will be placed. type: - string - 'null' x-go-name: TargetViewName x-go-package: magneto/master/base/master.pb RestoreOneDriveParams_DriveOwner_Drive: type: object properties: isEntireDriveRequired: description: 'Specify if the entire drive is to be restored. This field should be false if restore_item_vec size > 0.' type: - boolean - 'null' x-go-name: IsEntireDriveRequired restoreDriveId: description: Id of the drive whose items are being restored. type: - string - 'null' x-go-name: RestoreDriveId restoreItemVec: description: List of drive paths that need to be restored. type: - array - 'null' items: $ref: '#/components/schemas/RestoreOneDriveParams_DriveItem' x-go-name: RestoreItemVec x-go-package: magneto/base/magneto.pb NasBackupParams: description: Message to capture any additional backup params for a NAS environment. type: object title: NAS Backup Parameters. properties: backupExistingSnapshot: description: 'This bool parameter will be set only for DP volumes when customer doesn''t select the full_backup_snapshot_label and incremental_backup_snapshot_label. When set to true, backend will be using existing oldest snapshot for the first backup. Each incremental will be selected in ascending of snapshot create time on the source.' type: - boolean - 'null' x-go-name: BackupExistingSnapshot blacklistedIpAddrs: description: A list of IP addresses that should not be used. type: - array - 'null' items: type: string x-go-name: BlacklistedIpAddrs continueOnError: description: 'Whether the backup job should continue on errors for snapshot based backups. For non-snapshot-based generic NAS backup jobs, Magneto always continues on errors.' type: - boolean - 'null' x-go-name: ContinueOnError encryptionEnabled: description: Whether this backup job should use encryption. type: - boolean - 'null' x-go-name: EncryptionEnabled filteringPolicy: description: 'The filtering policy to decide which objects within a source should be backed up. If this is not specified, then all of the objects within the source will be backed up.' $ref: '#/components/schemas/FilteringPolicyProto' fldConfig: description: 'File level data lock configuration. To support File DataLock functionality similar to Netapp SnapLock, the following fields will be required from the user. This is same as what Cohesity as a filer offers for File DataLock.' $ref: '#/components/schemas/ViewIdMappingProto_FileLevelDataLockConfig' fullBackupSnapshotLabel: description: 'Only used when we backup using discovered snapshots. This prefix is to figure out which discovered snapshot we need to use for full backup.' type: - string - 'null' x-go-name: FullBackupSnapshotLabel incrementalBackupSnapshotLabel: description: 'Only used when we backup using discovered snapshots. This prefix is to figure out which discovered snapshot we need to use for incremental backup.' type: - string - 'null' x-go-name: IncrementalBackupSnapshotLabel isSourceInitiatedBackup: description: 'Source initiated backup when the source sends pushes the data like for example snapmirror based backup for netapp.' type: - boolean - 'null' x-go-name: IsSourceInitiatedBackup mixedModePreference: description: 'If the target entity is a mixed mode volume, which NAS protocol type the user prefer to backup. This does not apply to generic NAS and will be ignored.' type: - integer - 'null' format: int32 x-go-name: MixedModePreference s3Viewbackupproperties: description: This message captures all the details of S3 view. $ref: '#/components/schemas/S3ViewBackupProperties' snapshotChangeEnabled: description: 'Whether this backup job should utilize changelist like API when available for faster incremental backups.' type: - boolean - 'null' x-go-name: SnapshotChangeEnabled x-go-package: magneto/base/env_params.pb User: description: Specifies details about a user. type: object title: User Details. properties: additionalGroupNames: description: 'Array of Additional Groups. Specifies the names of additional groups this User may belong to.' type: - array - 'null' items: type: string x-go-name: AdditionalGroupNames authenticationType: description: 'Specifies the authentication type of the user. ''kAuthLocal'' implies authenticated user is a local user. ''kAuthAd'' implies authenticated user is an Active Directory user. ''kAuthSalesforce'' implies authenticated user is a Salesforce user. ''kAuthGoogle'' implies authenticated user is a Google user. ''kAuthSso'' implies authenticated user is an SSO user.' type: - string - 'null' enum: - kAuthLocal - kAuthAd - kAuthSalesforce - kAuthGoogle - kAuthSso x-go-name: AuthenticationType clusterIdentifiers: description: 'Specifies the list of clusters this user has access to. If this is not specified, access will be granted to all clusters.' type: - array - 'null' items: $ref: '#/components/schemas/ClusterIdentifier' x-go-name: ClusterIdentifiers createdTimeMsecs: description: 'Specifies the epoch time in milliseconds when the user account was created on the Cohesity Cluster.' type: - integer - 'null' format: int64 x-go-name: CreatedTimeMsecs description: description: Specifies a description about the user. type: - string - 'null' x-go-name: Description domain: description: 'Specifies the fully qualified domain name (FQDN) of an Active Directory or LOCAL for the default LOCAL domain on the Cohesity Cluster. A user is uniquely identified by combination of the username and the domain.' type: - string - 'null' x-go-name: Domain effectiveTimeMsecs: description: 'Specifies the epoch time in milliseconds when the user becomes effective. Until that time, the user cannot log in.' type: - integer - 'null' format: int64 x-go-name: EffectiveTimeMsecs emailAddress: description: Specifies the email address of the user. type: - string - 'null' x-go-name: Email expiredTimeMsecs: description: 'Specifies the epoch time in milliseconds when the user becomes expired. After that, the user cannot log in.' type: - integer - 'null' format: int64 x-go-name: ExpiredTimeMsecs forcePasswordChange: description: Specifies whether to force user to change password. type: - boolean - 'null' x-go-name: ForcePasswordChange googleAccount: description: 'Specifies additional information pertaining to Google account. This field is set only for Helios BaaS users who has account on Google.' $ref: '#/components/schemas/GoogleAccountInfo' groupRoles: description: 'Specifies the Cohesity roles to associate with the user'' group. These roles can only be edited from group.' type: - array - 'null' items: type: string x-go-name: GroupRoles readOnly: true idpUserInfo: description: 'Specifies additional information pertaining to an IdP user. This field is set only for IdP users who has logged in via IdP.' $ref: '#/components/schemas/IdpUserInfo' lastUpdatedTimeMsecs: description: 'Specifies the epoch time in milliseconds when the user account was last modified on the Cohesity Cluster.' type: - integer - 'null' format: int64 x-go-name: LastUpdatedTimeMsecs orgMembership: description: 'OrgMembership contains the list of all available tenantIds for this user to switch to. Only when creating the session user, this field is populated on the fly. We discover the tenantIds from various groups assigned to the users.' type: - array - 'null' items: $ref: '#/components/schemas/TenantConfig' x-go-name: OrgMembership password: description: Specifies the password of this user. type: - string - 'null' x-go-name: Password preferences: description: Specifies preferences of the user. $ref: '#/components/schemas/Preferences' primaryGroupName: description: Specifies the name of the primary group of this User. type: - string - 'null' x-go-name: PrimaryGroupName privilegeIds: description: 'Array of Privileges. Specifies the Cohesity privileges from the roles. This will be populated based on the union of all privileges in roles. Type for unique privilege Id values. All below enum values specify a value for all uniquely defined privileges in Cohesity.' type: - array - 'null' items: type: string enum: - kPrincipalView - kPrincipalModify - kAppLaunch - kAppsManagement - kOrganizationView - kOrganizationModify - kOrganizationImpersonate - kCloneView - kCloneModify - kClusterView - kClusterModify - kClusterCreate - kClusterSupport - kClusterUpgrade - kClusterRemoteView - kClusterRemoteModify - kClusterExternalTargetView - kClusterExternalTargetModify - kClusterAudit - kAlertView - kAlertModify - kVlanView - kVlanModify - kHybridExtenderView - kHybridExtenderDownload - kAdLdapView - kAdLdapModify - kSchedulerView - kSchedulerModify - kProtectionView - kProtectionModify - kProtectionJobOperate - kProtectionSourceModify - kProtectionPolicyView - kProtectionPolicyModify - kRestoreView - kRestoreModify - kRestoreDownload - kRemoteRestore - kStorageView - kStorageModify - kStorageDomainView - kStorageDomainModify - kAnalyticsView - kAnalyticsModify - kReportsView - kMcmModify - kDataSecurity - kSmbBackup - kSmbRestore - kSmbTakeOwnership - kSmbAuditing - kMcmUnregister - kMcmUpgrade - kMcmModifySuperAdmin - kMcmViewSuperAdmin - kMcmModifyCohesityAdmin - kMcmViewCohesityAdmin - kObjectSearch - kFileDatalockExpiryTimeDecrease x-go-name: PrivilegeIds restricted: description: 'Whether the user is a restricted user. A restricted user can only view the objects he has permissions to.' type: - boolean - 'null' x-go-name: Restricted roles: description: 'Array of Roles. Specifies the Cohesity roles to associate with the user such as such as ''Admin'', ''Ops'' or ''View''. The Cohesity roles determine privileges on the Cohesity Cluster for this user.' type: - array - 'null' items: type: string x-go-name: Roles s3AccessKeyId: description: Specifies the S3 Account Access Key ID. type: - string - 'null' x-go-name: S3AccessKeyId s3AccountId: description: Specifies the S3 Account Canonical User ID. type: - string - 'null' x-go-name: S3AccountId s3SecretKey: description: Specifies the S3 Account Secret Key. type: - string - 'null' x-go-name: S3SecretKey salesforceAccount: description: 'Specifies additional information pertaining to Salesforce account. This field is set only for Helios users who has account on Salesforce.' $ref: '#/components/schemas/SalesforceAccountInfo' sid: description: 'Specifies the unique Security ID (SID) of the user. This field is mandatory in modifying user.' type: - string - 'null' x-go-name: Sid tenantId: description: Specifies the effective Tenant ID of the user. type: - string - 'null' x-go-name: TenantId username: description: Specifies the login name of the user. type: - string - 'null' x-go-name: Username x-go-package: cohesity/iris/server/data/public SalesforceAccountInfo: description: Salesforce Account Information of a Helios user. type: object title: Salesforce Account Information. properties: accountId: description: Specifies the Account Id assigned by Salesforce. type: - string - 'null' x-go-name: AccountId userId: description: Specifies the User Id assigned by Salesforce. type: - string - 'null' x-go-name: UserId x-go-package: cohesity/iris/server/data/public CloneAppViewInfoOracle: description: 'This message encapsulates backup view Clone operation information of a Oracle DB.' type: object properties: mountPathInfoVec: type: - array - 'null' items: type: string x-go-name: MountPathInfoVec x-go-package: magneto/base/magneto.pb CloudDeployTargetDetails: description: 'Message that specifies the details about CloudDeploy target where backup snapshots may be converted and stored.' type: object properties: awsParams: description: Specifies various resources when converting and deploying a VM to AWS. title: 'Contains information needed to identify various resources when deploying VMs to Cloud.' $ref: '#/components/schemas/AwsParams' azureParams: description: Specifies various resources when converting and deploying a VM to Azure. $ref: '#/components/schemas/AzureParams' gcpParams: description: Specifies various resources when converting and deploying a VM to Gcp. $ref: '#/components/schemas/GcpParams' id: description: 'Entity corresponding to the cloud deploy target. Specifies the id field inside the EntityProto.' type: - integer - 'null' format: int64 x-go-name: Id name: description: 'Specifies the inner object''s name or a human-readable string made off the salient attributes. This is only plumbed when Entity objects are exposed to Iris BE or to Yoda.' type: - string - 'null' x-go-name: DisplayName type: description: 'Specifies the type of the CloudDeploy target. ''kAzure'' indicates that Azure as a cloud deploy target type. ''kAWS'' indicates that AWS as a cloud deploy target type. ''kGCP'' indicates that GCP as a cloud deploy target type.' type: - string - 'null' enum: - kAzure - kAWS - kGCP x-go-name: Type x-go-package: cohesity/iris/server/data/public AWSFleetParams_Tag: type: object title: Tag information. properties: key: description: Key for the tag. type: - string - 'null' x-go-name: Key value: description: Value for the tag. type: - string - 'null' x-go-name: Value x-go-package: magneto/base/entities/aws.pb UserInformation: description: 'A message to encapsulate information about the user who made the request. Request should be filtered by these fields if specified so that only the objects that the user is permissioned for are returned. If both sid_vec & tenant_id are specified then an intersection of respective results should be returned.' type: object title: User Information. properties: includeSubtenantObjects: description: 'Whether objects owned by subtenants should be returned. This would require a prefix search with the passed tenant_id. All tenants are considered sub-tenants of the admin. For GET requests, if tenant id is empty(admin user is querying) and if this flag is false, we will only return untagged objects. If it is true, we will return everything.' type: - boolean - 'null' x-go-name: IncludeSubtenantObjects pulseAttributeVec: description: 'Specifies the KeyValuePair that client (eg. Iris) wants to persist along with the corresponding (soon-to-be-created) Pulse task for the current action. Eg. pulse_attribute_vec can drive user notifications by associating a Pulse Task with user SID and later Pulse can be searched by client specified Sid to get all finished tasks for the logged in user.' type: - array - 'null' items: $ref: '#/components/schemas/KeyValuePair' x-go-name: PulseAttributeVec sidVec: description: 'If specified, only the objects associated with these SIDs should be returned.' type: - array - 'null' items: $ref: '#/components/schemas/ClusterConfigProto_SID' x-go-name: SidVec tenantIdVec: description: 'If specified, only the objects associated with this tenant should be returned. A given tenant ID is always a prefix of the ids of its subtenants. Eg. if tenant_id of cluster admin is empty string then it will be a prefix match for all the tenants on the cluster.' type: - array - 'null' items: type: string x-go-name: TenantIdVec x-go-package: magneto/base/permissions.pb RestoreHyperVVMParams: type: object title: This message defines the HyperV specific VMs restore params. properties: copyRecovery: description: Whether to perform copy recovery. type: - boolean - 'null' x-go-name: CopyRecovery datastoreEntity: description: 'A datastore entity where the object''s files should be restored to. This field is optional if object is being restored to its original parent source. If not specified, the object''s files will be restored to their original datastore locations. This field is mandatory if object is being restored to a different resource entity or to a different parent source.' $ref: '#/components/schemas/EntityProto' powerStateConfig: description: 'Semantics for kRecoverVMs task: By default, VMs are restored in their original power state. This proto can be used to override the default behavior for the restore task.' title: The power state configuration to be applied to the restored VM. $ref: '#/components/schemas/PowerStateConfigProto' renameRestoredObjectParam: description: 'By default, VMs are restored with their original name. This field can be used to specify the transformation ( i.e prefix/suffix) to be applied to the source VM name to derive the new name of the restored VM.' $ref: '#/components/schemas/RenameObjectParamProto' resourceEntity: description: 'This field is optional for a kRecoverVMs task if the VMs are being restored to its original parent source. If not specified, restored VMs will be attached to its original host. This field is mandatory if the VMs are being restored to a different parent source.' title: The resource (HyperV host) to which the restored VM will be attached. $ref: '#/components/schemas/EntityProto' restoredObjectsNetworkConfig: description: 'Semantics for kRecoverVMs task: By default, if the VMs are being restored to their original location, then original network configuration will be preserved. If objects are being restored to different location (i.e., different parent source), then network will be detached. Below field can be used to override the default network configuration of the restored VMs. If user want to keep the original network setting for kRecoverVMs task, then this proto should not be set.' title: The network configuration to be applied to the restored VMs. $ref: '#/components/schemas/RestoredObjectNetworkConfigProto' uuidConfig: description: 'Semantics for kRecoverVMs task: By default, recovered VMs have new UUIDs for them. This proto can be used to override the default behavior for the restore task.' title: UUID config to use for restored VM. $ref: '#/components/schemas/UuidConfigProto' x-go-package: magneto/base/magneto.pb S3BucketConfigProto_TagMapEntry: type: object properties: key: type: - string - 'null' x-go-name: Key value: type: - string - 'null' x-go-name: Value x-go-package: bridge/s3_portal/base/s3_metadata.pb OracleDBChannelInfo_HostInfo: description: 'The name of this proto message is out-dated. This proto should generally be used to represent parameters needed for each Oracle ''cluster'' node. ''cluster'' here is a loose term used to include more than Oracle RAC cluster, e.g. ''active-passive'' cluster is also considered here as ''cluster'' and its ''cluster node will also be represented by the following proto.' type: object properties: host: description: '''agent_id'' of the host from which we are allowed to take the backup/restore.' type: - string - 'null' x-go-name: Host numChannels: description: 'Number of channels we need to create for this host. Default value for num_channels will be calculated as minimum of number of nodes in cohesity cluster, 2 * number of cpu on Oracle host.' type: - integer - 'null' format: int32 x-go-name: NumChannels portnum: description: port number where database is listening. type: - integer - 'null' format: int64 x-go-name: Portnum sbtHostParams: description: 'The necessury parameters for SBT. This is set only when backup type is kSbt.' $ref: '#/components/schemas/OracleSbtHostParams' x-go-package: magneto/base/env_params.pb RecoverDisksTaskStateProto: type: object title: Persistent state for a "recover disks" restore task. properties: recoverVirtualDiskInfo: description: Captures the details of the recover virtual disk info. $ref: '#/components/schemas/RecoverVirtualDiskInfoProto' recoverVirtualDiskParams: description: Captures the original parameters from Iris. $ref: '#/components/schemas/RecoverVirtualDiskParams' x-go-package: magneto/master/base/master.pb CloudDeployInfoProto: description: 'Each available extension is listed below along with the location of the proto file (relative to magneto/connectors) where it is defined. The extension applies to both CloudDeployInfoProto as well as CloudDeployEntity. CloudDeployInfoProto extension Location Extension ============================================================================= aws::CloudDeployInfo::aws_cloud_deploy_info aws/aws.proto 100 azure::CloudDeployInfo::azure_cloud_deploy_info azure/azure.proto 101 gcp::CloudDeployInfo::gcp_cloud_deploy_info gcp/gcp.proto 102 aws::ReplicationInfo::aws_replication_info aws/aws.proto 103 azure::ReplicationInfo::azure_replication_info azure/azure.proto 104 ============================================================================= CloudDeployInfoProto.CloudDeployEntity extension Location Extension ============================================================================= aws::CloudDeployEntityInfo::aws_cloud_deploy_entity_info aws/aws.proto 100 vmware::RestoreEntityInfo::vmware_cloud_deploy_entity_info vmware/vmware.proto 101 azure::CloudDeployEntityInfo::azure_cloud_deploy_entity_info azure/azure.proto 102 gcp::CloudDeployEntityInfo::gcp_cloud_deploy_entity_info gcp/gcp.proto 103 hyperv::RestoreEntityInfo::hyperv_cloud_deploy_entity_info hyperv/hyperv.proto 104 aws::ReplicationEntityInfo::aws_replication_entity_info aws/aws.proto 105 aws::ReplicationEntityInfo::azure_replication_entity_info azure/azure.proto 106 =============================================================================' type: object title: 'Message that encapsulates information about cloud deploy tasks for any of the cloud environments we support. Environment specific infos are defined as extensions to this proto.' properties: cloudDeployEntityVec: description: 'Contains the file paths and the information of the entities deployed to cloud.' type: - array - 'null' items: $ref: '#/components/schemas/CloudDeployInfoProto_CloudDeployEntity' x-go-name: CloudDeployEntityVec isIncremental: description: Whether this Cloud deploy info is for incremental cloudspin. type: - boolean - 'null' x-go-name: IsIncremental restoreInfo: description: This will be filled by some restore ops to checkpoint their restore state. $ref: '#/components/schemas/RestoreInfoProto' targetType: description: 'Specifies the target type for the task. The field is only valid if the task has got a permit.' type: - integer - 'null' format: int32 x-go-name: TargetType totalBytesTransferredToSource: description: Total bytes transferred to source. type: - integer - 'null' format: int64 x-go-name: TotalBytesTransferredToSource type: description: The type of environment this cloud deploy info pertains to. type: - integer - 'null' format: int32 x-go-name: Type x-go-package: magneto/base/magneto.pb RestoreAcropolisVMParam: type: object title: Message to capture the info of a particular Acropolis VM being restored. properties: baseCbtSnapshotInfoProto: description: 'If specified, this field defines the info of the snapshot that is known to be present on both Acropolis and Cohesity cluster. We can compute the changed blocks between the snapshot to be restored and this reference snapshot and thus push only changed blocks to the Acropolis cluster for fast/incremental recovery. If this field is not specified, Cohesity cluster will push all the VM snapshot data back to the Acropolis cluster.' $ref: '#/components/schemas/SnapshotInfoProto' networkConfig: $ref: '#/components/schemas/RestoreAcropolisVMParam_NetworkConfigInfo' x-go-package: magneto/base/magneto.pb AppOwnerRestoreInfo: type: object title: Message that captures information about an application's owner. properties: ownerObject: description: 'In the SQL and Oracle applications, this also specifies the full/incremental snapshot to use for non-PIT restore operations, and optionally PIT restore operations as well.' title: 'The information about the owner object and its job details. This should be set to an object such as a VM.' $ref: '#/components/schemas/RestoreObject' ownerRestoreParams: description: The params to restore the owner object. $ref: '#/components/schemas/RestoreObjectParams' performRestore: description: 'If this is set to true, then the owner object needs to be restored. The restore options that follow only apply if this field is set to true. If this field is not set, then the application objects will be restored to the original owner from where they were backed up.' type: - boolean - 'null' x-go-name: PerformRestore x-go-package: magneto/base/magneto.pb DestroyClonedEntityInfoProto: description: 'Each available extension is listed below along with the location of the proto file (relative to magneto/connectors) where it is defined. DestroyClonedEntityInfoProto.ClonedEntity extension Location Extension ============================================================================= azure::ClonedEntityInfo::azure_cloned_entity_info azure/azure.proto 100 aws::ClonedEntityInfo::aws_cloned_entity_info aws/aws.proto 101 =============================================================================' type: object title: 'Message that encapsulates information about a cloned entity that needs to be destroyed. Environment specific information are defined as extensions to this proto.' properties: clonedEntity: description: 'The following field is set by the master in order for slave to identify the entities that need to be destroyed.' $ref: '#/components/schemas/DestroyClonedEntityInfoProto_ClonedEntity' clonedEntityStatus: type: - integer - 'null' format: int32 x-go-name: ClonedEntityStatus destroyClonedEntityState: description: 'The state of the destroy/teardown of a cloned entity (i.e, VM). The following two fields are set by the slave in order for the master to find status of the destroy operation.' type: - integer - 'null' format: int32 x-go-name: DestroyClonedEntityState error: description: 'If the destruction of this entity failed, this field will contain the cause of the failure.' $ref: '#/components/schemas/ErrorProto' fullViewName: description: The full external view name where cloned objects are placed. type: - string - 'null' x-go-name: FullViewName type: description: The type of environment this destroy cloned entity info pertains to. type: - integer - 'null' format: int32 x-go-name: Type x-go-package: magneto/base/magneto.pb GoogleAccountInfo: description: Google Account Information of a Helios BaaS user. type: object title: Google Account Information. properties: accountId: description: Specifies the Account Id assigned by Google. type: - string - 'null' x-go-name: AccountId userId: description: Specifies the User Id assigned by Google. type: - string - 'null' x-go-name: UserId x-go-package: cohesity/iris/server/data/public NoSqlRecoverJobParams: type: object properties: bandwidthBytesPerSecond: description: Net bandwidth bytes per second type: - integer - 'null' format: int64 x-go-name: BandwidthBytesPerSecond cassandraRecoverJobParams: description: Params specific to cassandra recover job. $ref: '#/components/schemas/CassandraRecoverJobParams' concurrency: description: Max number of mappers type: - integer - 'null' format: int32 x-go-name: Concurrency couchbaseRecoverJobParams: description: Params specific to couchbase recover job. $ref: '#/components/schemas/CouchbaseRecoverJobParams' hbaseRecoverJobParams: description: Params specific to hbase recover job. $ref: '#/components/schemas/HBaseRecoverJobParams' hdfsRecoverJobParams: description: Params specific to hdfs recover job. $ref: '#/components/schemas/HdfsRecoverJobParams' hiveRecoverJobParams: description: Params specific to hive recover job. $ref: '#/components/schemas/HiveRecoverJobParams' mongodbRecoverJobParams: description: Params specific to mongodb recover job. $ref: '#/components/schemas/MongoDBRecoverJobParams' overwrite: description: 'Whether to overwrite or keep the object if the object being recovered already exists in the destination.' type: - boolean - 'null' x-go-name: Overwrite x-go-package: magneto/base/nosql.pb DeployDBInstancesToRDSParams_PointInTimeRestoreParams: description: 'Message to capture details of a point in time that the DB needs to be restored to.' type: object properties: timestampMsecs: description: Time in milliseconds since epoch that the DB needs to be restored to. type: - integer - 'null' format: int64 x-go-name: TimestampMsecs x-go-package: magneto/base/cloud_deploy.pb NetworkMappingProto: type: object properties: disableNetwork: description: 'This can be set to true to indicate that the attached network should be left in disabled state. This value takes priority over the value in RestoredObjectNetworkConfigProto.' type: - boolean - 'null' x-go-name: DisableNetwork preserveMacAddressOnNewNetwork: description: 'VM''s MAC address will be preserved on the new network. This value takes priority over the value in RestoredObjectNetworkConfigProto.' type: - boolean - 'null' x-go-name: PreserveMacAddressOnNewNetwork sourceNetworkEntity: description: 'The network entity (i.e, either a standard switch port group or a distributed port group in a VMware env) that is attached to one of the source object.' $ref: '#/components/schemas/EntityProto' targetNetworkEntity: description: 'The network entity (i.e, either a standard switch port group or a distributed port group in a VMware env) that will be attached to one of the target object.' $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/magneto.pb CassandraSecurityInfo: description: Specifies an Object containing information on Cassandra security. type: object title: CassandraSecurityInfo Cassandra security info. properties: cassandraAuthRequired: description: Is Cassandra authentication required ? type: - boolean - 'null' x-go-name: CassandraAuthRequired cassandraAuthType: description: 'Cassandra Authentication type. Enum: [PASSWORD KERBEROS LDAP] Specifies the Cassandra auth type. ''PASSWORD'' ''KERBEROS'' ''LDAP''' type: - string - 'null' enum: - PASSWORD - KERBEROS - LDAP x-go-name: CassandraAuthType cassandraAuthorizer: description: Cassandra Authenticator/Authorizer. type: - string - 'null' x-go-name: CassandraAuthorizer clientEncryption: description: Is Client Encryption enabled for this cluster ? type: - boolean - 'null' x-go-name: ClientEncryption dseAuthorization: description: Is DSE Authorization enabled for this cluster ? type: - boolean - 'null' x-go-name: DseAuthorization serverEncryptionReqClientAuth: description: Is 'Server encryption request client authentication' enabled for this cluster ? type: - boolean - 'null' x-go-name: ServerEncryptionReqClientAuth serverInternodeEncryptionType: description: '''Server internal node Encryption'' type for this cluster.' type: - string - 'null' x-go-name: ServerInternodeEncryptionType x-go-package: cohesity/iris/server/data/public RestoreFilesParams: description: 'This message captures all the necessary arguments specified by the user to restore files to the source.' type: object properties: blacklistedIpAddrs: description: A list of target IP addresses that should not be used. type: - array - 'null' items: type: string x-go-name: BlacklistedIpAddrs destinationEpUuid: description: Destination endpoint UUID for source s3 objectstore. type: - string - 'null' x-go-name: DestinationEpUuid directoryNameSecurityStyleMap: description: 'Directory name security style map contains mapping of the directory name to security style it supports. This is needed to restore the same permission for the given directory for Qtrees.' type: - array - 'null' items: $ref: '#/components/schemas/RestoreFilesParams_DirectoryNameSecurityStyleMapEntry' x-go-name: DirectoryNameSecurityStyleMap isArchiveFlr: description: Whether this is a file restore operation from an archive. type: - boolean - 'null' x-go-name: IsArchiveFlr isFileVolumeRestore: description: Whether this is a file based volume restore. type: - boolean - 'null' x-go-name: IsFileVolumeRestore isMountBasedFlr: description: Whether this is a mount based file restore operation type: - boolean - 'null' x-go-name: IsMountBasedFlr isSourceInitiatedRestore: description: Whether this is a source initiated restore. type: - boolean - 'null' x-go-name: IsSourceInitiatedRestore mountDisksOnVm: description: 'Whether this will attach disks or mount disks on the VM side OR use Storage Proxy RPCs to stream data.' type: - boolean - 'null' x-go-name: MountDisksOnVm nasBackupParams: description: 'Used to determining filtering_policy for NAS Migration uptier operation. Currently this is set only if this is NAS Migration uptier operation.' $ref: '#/components/schemas/NasBackupParams' nasProtocolTypeVec: description: 'The NAS protocol type(s) of this restore task. Currently we only support a single restore type. This field is only populated for NAS restore tasks.' type: - array - 'null' items: type: integer format: int32 x-go-name: NasProtocolTypeVec objectstoreConfigName: description: Object store config name for source initiated backup. type: - string - 'null' x-go-name: ObjectstoreConfigName physicalFlrParallelRestore: description: 'If enabled, magneto physical file restore will be enabled via job framework' type: - boolean - 'null' x-go-name: PhysicalFlrParallelRestore proxyEntity: description: 'If the proxy entity is specified, then the virtual disks are attached to the proxy server and the file copy will be initiated through this server.' $ref: '#/components/schemas/EntityProto' proxyEntityParentSource: description: 'If the proxy entity above is specified, then it''s parent entity must be specified as well.' $ref: '#/components/schemas/EntityProto' restoreFilesPreferences: description: Preferences for the restore files operation. $ref: '#/components/schemas/RestoreFilesPreferences' restoreMethod: description: Determines the type of method to be used to perform FLR. type: - integer - 'null' format: int32 x-go-name: RestoreMethod restoredFileInfoVec: description: Information regarding files and directories. type: - array - 'null' items: $ref: '#/components/schemas/RestoredFileInfo' x-go-name: RestoredFileInfoVec s3Viewbackupproperties: description: 'This message captures all the details of S3 view from where the data is restored.' $ref: '#/components/schemas/S3ViewBackupProperties' sourceSnapshotName: description: Snapshot name need by source to start the restore. type: - string - 'null' x-go-name: SourceSnapshotName targetEntity: description: Target entity where the files are being restored to. title: 'The following fields only need to be set if restoring to a target location (i.e., not downloading the files directly).' $ref: '#/components/schemas/EntityProto' targetEntityCredentials: description: 'Credentials to access the target entity such as a VM. In case of physical server, the copy process will be launched as this user. NOTE: If proxy entity is specified, then this credentials will be used for running operations on proxy server as well.' $ref: '#/components/schemas/Credentials' targetEntityParentSource: description: 'The registered source (i.e vCenter or ESXi host in VMware environment) under which the target entity is present.' $ref: '#/components/schemas/EntityProto' targetHostEntity: description: 'Host entity where the target entity resides. This is only populated for Netapp environments right now if target_entity_parent_source is a cluster. For example, the host of a target Netapp volume will be the vserver it belongs to.' $ref: '#/components/schemas/EntityProto' targetHostType: description: 'The host environment type. This is set in VMware environment to indicate the OS type of the target entity. NOTE: This is expected to be set since magneto does not know the host type for VMware entities.' type: - integer - 'null' format: int32 x-go-name: TargetHostType uptierParams: description: Set if this is NAS Migration uptier operation. $ref: '#/components/schemas/FileUptieringParams' useExistingAgent: description: 'Whether this will use an existing agent on the target VM to do the restore. This field is deprecated. restore_method should be used for populating use of existing agent.' type: - boolean - 'null' x-go-name: UseExistingAgent viewId: description: View ID type: - integer - 'null' format: int64 x-go-name: ViewId viewName: description: Name of the S3 view type: - string - 'null' x-go-name: ViewName vpcConnectorEntity: description: Entity of the VPC connector, required in case of GCP FLR. $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/magneto.pb ArchivalExternalTarget: description: Specifies settings about the Archival External Target (such as Tape or AWS). type: object title: Archival Target. properties: vaultId: description: Specifies the id of Archival Vault assigned by the Cohesity Cluster. type: - integer - 'null' format: int64 x-go-name: VaultId vaultName: description: Name of the Archival Vault. type: - string - 'null' x-go-name: VaultName vaultType: description: 'Specifies the type of the Archival External Target such as ''kCloud'', ''kTape'' or ''kNas''. ''kCloud'' indicates the archival location as Cloud. ''kTape'' indicates the archival location as Tape. ''kNas'' indicates the archival location as Network Attached Storage (Nas).' type: - string - 'null' enum: - kCloud - kTape - kNas x-go-name: VaultType x-go-package: cohesity/iris/server/data/public RestoreInfoProto_RestoreEntity: type: object properties: entity: description: The entity that was restored. $ref: '#/components/schemas/EntityProto' error: description: 'If the restore of the ''entity'' failed, this field may contain the cause of the failure.' $ref: '#/components/schemas/ErrorProto' progressMonitorTaskPath: description: 'The path relative to the root path of the restore task progress monitor of the progress monitor for this entity.' type: - string - 'null' x-go-name: ProgressMonitorTaskPath publicStatus: description: Iris-facing task state. This field is stamped during the export. type: - integer - 'null' format: int32 x-go-name: PublicStatus relativeRestorePaths: description: 'All the paths that the entity''s files were restored to. Each path is relative to the destination view.' type: - array - 'null' items: type: string x-go-name: RelativeRestorePaths resourcePoolEntity: description: 'Even though, this field is redundant for kCloneVMs task, we will set this field for sake of consistency. Please note that this field may not be set if the restore of this entity fails.' title: 'This represents a cluster or a HyperV host in HyperV environments, and a resource pool in VMware environments. For a restore task of type kCloneVMs, all entities are attached to the same resource entity. So this field seems redundant for kCloneVMs task. However, for a restore task of type kRecoverVMs, an entity can be restored back to its original resource entity in which case value of this field can be different for different entities.' $ref: '#/components/schemas/EntityProto' restoredEntity: description: 'Note: For a recovery task in the VMware environment, once the VM is created, it is storage vMotioned to its primary datastore. If storage vMotion fails, Magneto marks the recovery task as failed. However, this field will still be set for the recovered VM. It can be used later to clean up the VM from primary environment (i.e, vCenter)' title: Proto of the entity created by the restore operation. $ref: '#/components/schemas/EntityProto' status: description: The restore status of the entity. type: - integer - 'null' format: int32 x-go-name: Status warnings: description: Optional warnings if any. type: - array - 'null' items: $ref: '#/components/schemas/ErrorProto' x-go-name: Warnings x-go-package: magneto/base/magneto.pb CouchbaseRecoverJobParams: description: 'Contains any additional couchbase environment specific params for the recover job.' type: object properties: suffix: description: A suffix that is to be applied to all recovered entities type: - string - 'null' x-go-name: Suffix x-go-package: magneto/base/nosql.pb DeployVMsToGCPParams: description: 'Contains GCP specific information needed to identify various resources when converting and deploying a VM to GCP.' type: object properties: projectId: description: Project id in which to deploy the VM. $ref: '#/components/schemas/EntityProto' region: description: Region in which to deploy the VM. $ref: '#/components/schemas/EntityProto' subnet: description: 'Name of the subnet in which to deploy the VM. The name of the VPC netowrk can be obtained from this subnet entity.' $ref: '#/components/schemas/EntityProto' zone: description: Zone in which to deploy the VM. $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/cloud_deploy.pb RestoreSiteParams_DriveItem: description: This will be set in case of partial drive recovery. type: object title: Defining DriveItem proto-message. properties: driveItemPath: description: The path of the drive item relative to root. type: - string - 'null' x-go-name: DriveItemPath id: description: The unique identifier of the item within the Drive. type: - string - 'null' x-go-name: Id isFileItem: description: Specify if the item is a file or not. type: - boolean - 'null' x-go-name: IsFileItem x-go-package: magneto/base/magneto.pb SqlUpdateRestoreTaskOptions: type: object title: SQL specific options to update a SQL restore task. properties: enableAutoSync: description: Enable/Disable auto_sync for db migration type: - boolean - 'null' x-go-name: EnableAutoSync multiStageRestoreAction: description: 'This field is set if we are performing an action on a multi-stage SQL restore.' type: - integer - 'null' format: int32 x-go-name: MultiStageRestoreAction x-go-package: magneto/base/magneto.pb OracleDBConfig_RedoLogGroupConf: description: 'GROUP1 : {DST1/CH1.log, DST2/CH1.log} GROUP2 : {DST1/CH2.log, DST2/CH2.log} GROUP3 : {DST1/CH3.log, DST2/CH3.log}' type: object title: Example redo log config for 3 groups and 2 members with prefix=CH. properties: groupMemberVec: description: List of members of this redo log group. type: - array - 'null' items: type: string x-go-name: GroupMemberVec memberPrefix: description: Log member name prefix. type: - string - 'null' x-go-name: MemberPrefix numGroups: description: Number of redo log groups. type: - integer - 'null' format: int32 x-go-name: NumGroups sizeMb: description: Size of the member in MB. type: - integer - 'null' format: int32 x-go-name: SizeMb x-go-package: magneto/base/magneto.pb DestroyClonedVMTaskInfoProto: description: 'Each available extension is listed below along with the location of the proto file (relative to magneto/connectors) where it is defined. DestroyClonedVMTaskInfoProto extension Location Extension ============================================================================= vmware::DestroyClonedTaskInfo:: vmware_destroy_cloned_vm_task_info vmware/vmware.proto 100 hyperv::DestroyClonedTaskInfo:: hyperv_destroy_cloned_vm_task_info hyperv/hyperv.proto 101 =============================================================================' type: object title: 'Message that encapsulates information about the destroy clone task for any environment we support. Environment specific information are defined as extensions to this proto.' properties: datastoreNotUnmountedReason: description: 'If datastore was not unmounted, this field contains the reason for the same.' type: - string - 'null' x-go-name: DatastoreNotUnmountedReason datastoreUnmounted: description: 'Whether the datastore corresponding to the clone view was unmounted from primary environment.' type: - boolean - 'null' x-go-name: DatastoreUnmounted destroyClonedEntityInfoVec: description: Vector of all cloned entities that this destroy task will teardown. type: - array - 'null' items: $ref: '#/components/schemas/DestroyClonedEntityInfoProto' x-go-name: DestroyClonedEntityInfoVec type: description: The type of environment this destroy clone task info pertains to. type: - integer - 'null' format: int32 x-go-name: Type viewDeleted: description: Whether the clone view was deleted by the destroy task. type: - boolean - 'null' x-go-name: ViewDeleted x-go-package: magneto/base/magneto.pb RecoverVolumesTaskStateProto_TaskResult: type: object title: Contains high-level per-volume information. properties: dstGuid: description: Volume GUID for the Target Entity (phy host). type: - string - 'null' x-go-name: DstGuid error: description: Contains details when the associated subtask fails. $ref: '#/components/schemas/ErrorProto' progressMonitorTaskPath: description: The path relative to the root path of the restore task progress monitor. type: - string - 'null' x-go-name: ProgressMonitorTaskPath x-go-package: magneto/master/base/master.pb CloneAppViewParams: description: 'This message encapsulates the generic information required for cloning and App view.' type: object properties: mountPathIdentifier: description: 'Mount path identifier, which identifies the sub-dir where the cohesity view for App recovery will be mounted.' type: - string - 'null' x-go-name: MountPathIdentifier x-go-package: magneto/base/magneto.pb FilesToDirectoryMapping: type: object title: A message that specifes files and their corresponding direcory. properties: filePattern: description: Source file name. The file name can be a regex matching source files. type: - string - 'null' x-go-name: FilePattern targetDirectory: description: Target directtory for the source file pattern. type: - string - 'null' x-go-name: TargetDirectory x-go-package: magneto/base/common.pb OracleSbtHostParams: type: object title: Message to capture Oracle SBT host info. properties: sbtLibraryPath: description: The path of sbt library, This is set only when backup type is kSbt. type: - string - 'null' x-go-name: SbtLibraryPath viewFsPath: description: Cohesity view path. type: - string - 'null' x-go-name: ViewFsPath vipVec: description: Vector of Cohesity primary VIPs. type: - array - 'null' items: type: string x-go-name: VipVec vlanInfoVec: description: Vlan information for Cohesity cluster. type: - array - 'null' items: $ref: '#/components/schemas/OracleVlanInfo' x-go-name: VlanInfoVec x-go-package: magneto/base/env_params.pb MetricValue: description: Specifies one data point of a metric. type: object title: Metric Value. properties: metricName: description: Specifies the metric name. type: - string - 'null' x-go-name: MetricName timestampMsecs: description: 'Specifies the creation time of a data point as a Unix epoch Timestamp (in milliseconds).' type: - integer - 'null' format: int64 x-go-name: TimestampMsecs value: description: Specifies the value of the data point. $ref: '#/components/schemas/Value' x-go-package: stats/base/stats.pb CassandraPortsInfo: description: Specifies an Object containing information on various Cassandra ports. type: object title: Cassandra Ports Info. properties: jmxPort: description: Specifies the Cassandra JMX port. type: - integer - 'null' format: uint32 x-go-name: JmxPort nativeTransportPort: description: Specifies the port for the CQL native transport. type: - integer - 'null' format: uint32 x-go-name: NativeTransportPort rpcPort: description: 'Specifies the Remote Procedure Call (RPC) port for general mechanism for client-server applications.' type: - integer - 'null' format: uint32 x-go-name: RpcPort sslStoragePort: description: Specifies the SSL port for encrypted communication. type: - integer - 'null' format: uint32 x-go-name: SslStoragePort storagePort: description: Specifies the TCP port for data. Internally used by Cassandra bulk loader. type: - integer - 'null' format: uint32 x-go-name: StoragePort x-go-package: cohesity/iris/server/data/public DeployDBInstancesToRDSParams: description: 'Contains RDS specfic options that can be supplied while restoring the RDS DB instance.' type: object properties: autoMinorVersionUpgrade: description: Whether to enable auto minor version upgrade in the restored DB. type: - boolean - 'null' x-go-name: AutoMinorVersionUpgrade availabilityZone: description: Entity representing the availability zone to use while restoring the DB. $ref: '#/components/schemas/EntityProto' copyTagsToSnapshots: description: Whether to enable copying of tags to snapshots of the DB. type: - boolean - 'null' x-go-name: CopyTagsToSnapshots dbInstanceId: description: 'The DB instance identifier to use for the restored DB. This field is required.' type: - string - 'null' x-go-name: DbInstanceId dbOptionGroup: description: Entity representing the RDS option group to use while restoring the DB. $ref: '#/components/schemas/EntityProto' dbParameterGroup: description: Entity representing the RDS parameter group to use while restoring the DB. $ref: '#/components/schemas/EntityProto' dbPort: description: Port to use for the DB in the restored RDS instance. type: - integer - 'null' format: int32 x-go-name: DbPort iamDbAuthentication: description: Whether to enable IAM authentication for the DB. type: - boolean - 'null' x-go-name: IamDbAuthentication multiAzDeployment: description: Whether this is a multi-az deployment or not. type: - boolean - 'null' x-go-name: MultiAzDeployment pointInTimeParams: description: If this is set, we will restore DB to the specified point in time. $ref: '#/components/schemas/DeployDBInstancesToRDSParams_PointInTimeRestoreParams' publicAccessibility: description: Whether this DB will be publicly accessible or not. type: - boolean - 'null' x-go-name: PublicAccessibility x-go-package: magneto/base/cloud_deploy.pb ReplicateSnapshotsToAzureParams: description: This is populated for Azure snapshot manager replication. type: object title: Params required to replicate snapshots to another Azure's storage container. properties: resourceGroup: description: Resource group to filter regions in UX. $ref: '#/components/schemas/EntityProto' storageAccount: description: 'Name of the storage account that will contain the storage container within which we will create the blob/snapshot.' $ref: '#/components/schemas/EntityProto' storageContainer: description: Name of the storage container within the above storage account. $ref: '#/components/schemas/EntityProto' storageResourceGroup: description: 'Name of the Azure resource group that has the storage account mentioned below.' $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/cloud_deploy.pb RestoreExchangeParams: type: object title: Params specific to restoring an Exchange application. properties: databaseOptions: description: Only applicable when ExchangeRestoreType.Type=kDatabase. $ref: '#/components/schemas/RestoreExchangeParams_DatabaseOptions' type: description: Restore type. type: - integer - 'null' format: int32 x-go-name: Type viewOptions: description: Only applicable when ExchangeRestoreType.Type=kView. $ref: '#/components/schemas/RestoreExchangeParams_ViewOptions' x-go-package: magneto/base/magneto.pb EntityIdentifier: description: Specifies a unique identifier for the entity. type: object title: Entity Identifier. properties: entityId: description: Specifies the unique identifier for the entity in the source Cluster. $ref: '#/components/schemas/Value' x-go-package: stats/base/stats.pb DestroyCloneAppTaskInfoProto: description: 'Each available extension is listed below along with the location of the proto file (relative to magneto/connectors) where it is defined. DestroyCloneAppTaskInfoProto extension Location Extension ============================================================================= sql::DestroyCloneTaskInfo::sql_destroy_clone_app_task_info sql/sql.proto 100 oracle::DestroyCloneTaskInfo::oracle_destroy_clone_app_task_info oracle/oracle.proto 101 ad::DestroyTaskInfo::ad_destroy_app_task_info ad/ad.proto 102 exchange::DestroyTaskInfo::exchange_destroy_app_task_info exchange/exchange.proto 103 =============================================================================' type: object title: 'Message that captures the destroy clone application task state. Application specific destroy clone infos are defined as extensions to this proto.' properties: appEnv: description: The application environment. type: - integer - 'null' format: int32 x-go-name: AppEnv error: description: If an error is encountered during destroy it is set here. $ref: '#/components/schemas/ErrorProto' finished: description: This will be set to true if the task is complete on the slave. type: - boolean - 'null' x-go-name: Finished targetEntity: description: The target entity on which the application was cloned. $ref: '#/components/schemas/EntityProto' targetEntityCredentials: description: Credentials if any needed to log into the target entity. $ref: '#/components/schemas/Credentials' x-go-package: magneto/base/magneto.pb NoSqlRecoverParams: type: object properties: restoreObjects: type: - array - 'null' items: $ref: '#/components/schemas/NoSqlRestoreObject' x-go-name: RestoreObjects x-go-package: magneto/base/magneto.pb ClusterConfigProto_QoSMapping_QoSContext: description: 'QoSContext captures the properties that are relevant for QoS in a request. If a new field is added to QoSContext, cluster_config.h should be changed to enhance the hasher (QoSContextHash) and comparator (QoSContextEqual) for QoSContext.' type: object properties: component: description: Component from which request is coming. type: - integer - 'null' format: int32 x-go-name: Component priority: description: Priority of a request. type: - integer - 'null' format: int32 x-go-name: Priority type: type: - integer - 'null' format: int32 x-go-name: Type viewBoxId: description: View box id of a request. type: - integer - 'null' format: int64 x-go-name: ViewBoxId viewId: description: View id of a request. type: - integer - 'null' format: int64 x-go-name: ViewId x-go-package: configs/cluster_config.pb KeystoneACLProto_Grantees_ProjectUsersMapEntry: type: object properties: key: type: - string - 'null' x-go-name: Key value: $ref: '#/components/schemas/KeystoneACLProto_Grantees_ProjectUsers' x-go-package: bridge/s3_portal/base/s3_metadata.pb RestoreKVMVMsParams: type: object title: This message defines the KVM specific VMs restore params. properties: clusterEntity: description: 'This field is optional for a kRecoverVMs task if the VMs are being restored to its original parent source. If not specified, restored VMs will be attached to its original host. This field is mandatory if the VMs are being restored to a different parent source.' title: The resource (KVMH host) to which the restored VM will be attached. $ref: '#/components/schemas/EntityProto' datacenterEntity: description: 'A datacenter where the VM''s files should be restored to. This field is optional if VM is being restored to its original parent source. If not specified, the VM''s files will be restored to their original datacenter locations. This field is mandatory if VM is being restored to a different datacenter entity or to a different parent source.' $ref: '#/components/schemas/EntityProto' powerStateConfig: description: 'Semantics for kRecoverVMs task: By default, VMs are restored in their original power state. This proto can be used to override the default behavior for the restore task.' title: The power state configuration to be applied to the restored VM. $ref: '#/components/schemas/PowerStateConfigProto' renameRestoredObjectParam: description: 'By default, VMs are restored with their original name. This field can be used to specify the transformation ( i.e prefix/suffix) to be applied to the source VM name to derive the new name of the restored VM.' $ref: '#/components/schemas/RenameObjectParamProto' restoredObjectsNetworkConfig: description: 'Semantics for kRecoverVMs task: By default, if the VMs are being restored to their original location, then original network configuration will be preserved. If objects are being restored to different location (i.e., different parent source), then network will be detached. Below field can be used to override the default network configuration of the restored VMs. If user want to keep the original network setting for kRecoverVMs task, then this proto should not be set.' title: The network configuration to be applied to the restored VMs. $ref: '#/components/schemas/RestoredObjectNetworkConfigProto' storagedomainEntity: description: 'A storagedomain where the VM''s disk should be restored to. This field is optional if VM is being restored to its original parent source. If not specified, the VM''s disk will be restored to their original storagedomain. This field is mandatory if VM is being restored to a different resource entity or to a different parent source.' $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/magneto.pb VolumeInfo_LogicalVolumeInfo: description: 'This is extra attribute which uniquely identifies a logical volume in LVM or LDM.' type: object title: The proto is used only for LVM (Linux) or LDM (Windows). properties: deviceTree: description: 'The tree defining how to combine partitions to create this logical volume.' $ref: '#/components/schemas/DeviceTree' logicalVolumeName: description: Logical volume name. type: - string - 'null' x-go-name: LogicalVolumeName logicalVolumeUuid: description: Logical volume uuid. type: - string - 'null' x-go-name: LogicalVolumeUuid volumeGroupName: description: Volume group name. type: - string - 'null' x-go-name: VolumeGroupName volumeGroupUuid: description: Volume group uuid. type: - string - 'null' x-go-name: VolumeGroupUuid x-go-package: yoda/base/volume_info.pb O365RegionProto: description: 'O365Region proto will store the information about the region from where o365 connector apis calls are made.' type: object properties: country: description: The country where the o365 connector apis were called from. type: - integer - 'null' format: int32 x-go-name: Country x-go-package: magneto/connectors/o365/o365_additional.pb SnapshotInfoProto: description: 'Each available extension is listed below along with the location of the proto file (relative to magneto/connectors) where it is defined. The only exception is view.proto and physical.proto which reside in magneto/base. SnapshotInfoProto extension Location Extn ============================================================================= vmware::SnapshotInfo::vmware_snapshot_info vmware/vmware.proto 100 sql::SnapshotInfo::sql_snapshot_info sql/sql.proto 101 view::SnapshotInfo::view_snapshot_info base/view.proto 102 physical::SnapshotInfo::physical_snapshot_info base/physical.proto 103 san::SnapshotInfo::san_snapshot_info san/san.proto 104 file::SnapshotInfo::file_snapshot_info file/file.proto 105 hyperv::SnapshotInfo::hyperv_snapshot_info hyperv/hyperv.proto 106 acropolis::SnapshotInfo:: acropolis_snapshot_info acropolis/acropolis.proto 107 kvm::SnapshotInfo::kvm_snapshot_info kvm/kvm.proto 108 app_file::SnapshotInfo::app_file_snapshot_info app_file/app_file.proto 109 oracle::SnapshotInfo::oracle_snapshot_info oracle/oracle.proto 110 aws::SnapshotInfo::aws_snapshot_info aws/aws.proto 111 outlook::SnapshotInfo::outlook_snapshot_info outlook/outlook.proto 112 azure::SnapshotInfo::azure_snapshot_info azure/azure.proto 113 gcp::SnapshotInfo::gcp_snapshot_info gcp/gcp.proto 114 ad::SnapshotInfo::ad_snapshot_info ad/ad.proto 115 MSGraph::SnapshotInfo::one_drive_snapshot_info ms_graph/graph.proto 116 kubernetes::SnapshotInfo:: kubernetes_snapshot_info kubernetes/kubernetes.proto 117 aws::RDSSnapshotInfo::rds_snapshot_info aws/aws.proto 118 o365::SnapshotInfo::o365_snapshot_info o365/o365.proto 119 exchange::SnapshotInfo::exchange_snapshot_info exchange/exchange.proto 120 o365::SharepointSnapshotInfo::sharepoint_snapshot_info o365/o365.proto 121 MSGraph::SharepointListSnapshotInfo::sharepoint_list_snapshot_info ms_graph/graph.proto 122 cdp::SnapshotInfo::cdp_snapshot_info base/cdp.proto 123 imanis::SnapshotInfo::nosql_snapshot_info imanis/nosql.proto 124 o365::PublicFolderSnapshotInfo::public_folder_snapshot_info o365/o365.proto 125 =============================================================================' type: object title: 'Message that encapsulates information about snapshots for any of the environments we support. Environment specific snapshot infos are defined as extensions to this proto.' properties: errorRocksdbName: description: 'The name of the rocksdb directory for errors seen during this backup, stored in ''config'' directory of the current view.' type: - string - 'null' x-go-name: ErrorRocksdbName fileWalkDone: description: 'This field is only applicable for NAS and file backup jobs. It indicates whether the file walk portion of the backup has completed.' type: - boolean - 'null' x-go-name: FileWalkDone numAppInstances: description: 'Number of application instances backed up by this task. For example, if the environment type is kSQL, this number is for the SQL server instances.' type: - integer - 'null' format: int32 x-go-name: NumAppInstances numAppObjects: description: 'Number of application objects in total backed up by this task. For example, if the environment type is kSQL, this number is for all of the SQL server databases' type: - integer - 'null' format: int32 x-go-name: NumAppObjects postBackupScriptStatus: description: Captures the execution status of post backup script. $ref: '#/components/schemas/ScriptExecutionStatus' preBackupScriptStatus: description: Captures the execution status of pre backup script. $ref: '#/components/schemas/ScriptExecutionStatus' relativeSnapshotDir: description: 'This is the path relative to ''root_path'' under which the snapshot lives. This does not begin with a ''/'' and is of the form foo/bar/baz.' type: - string - 'null' x-go-name: RelativeSnapshotDir rootPath: description: 'The root path under which the snapshot is stored. This is of the form "/ViewBox/ViewName/fs".' type: - string - 'null' x-go-name: RootPath scribeTableColumn: description: 'If this backup task stores any auxiliary state in Scribe table, this field will be populated with the column key in that table where such state is stored. Data stored in the column is extension of SnapshotScribeInfoProto message.' type: - string - 'null' x-go-name: ScribeTableColumn scribeTableRow: description: 'If this backup task stores any auxiliary state in Scribe table, this field will be populated with the row key in that table where such state is stored.' type: - string - 'null' x-go-name: ScribeTableRow slaveTaskStartTimeUsecs: description: This is the timestamp at which the slave task started. type: - integer - 'null' format: int64 x-go-name: SlaveTaskStartTimeUsecs snapshotType: description: Captures the snapshot type for some objects such as VM. $ref: '#/components/schemas/ObjectSnapshotType' sourceSnapshotCreateTimeUsecs: description: The source snapshot create time. type: - integer - 'null' format: int64 x-go-name: SourceSnapshotCreateTimeUsecs sourceSnapshotName: description: 'This filed is only applicable for NAS when we do backup from Readonly/DataProtect volume where we use already created snapshot on the source.' type: - string - 'null' x-go-name: SourceSnapshotName storageSnapshotProvider: description: Specifies the parameters required for Storage Snapshot provider. $ref: '#/components/schemas/StorageSnapshotProviderParams' targetType: description: 'Specifies the target type for the task. The field is only valid if the task has got a permit.' type: - integer - 'null' format: int32 x-go-name: TargetType totalBytesReadFromSource: description: 'Contains the information regarding number of bytes that are read from the source (such as VM) so far.' type: - integer - 'null' format: int64 x-go-name: TotalBytesReadFromSource totalBytesToReadFromSource: description: 'Contains the total number of bytes that will be read from the source (such as VM) for this snapshot.' type: - integer - 'null' format: int64 x-go-name: TotalBytesToReadFromSource totalChangedEntityCount: description: 'The total number of file and directory entities that have changed since last backup. Only applicable to file based backups.' type: - integer - 'null' format: int64 x-go-name: TotalChangedEntityCount totalEntityCount: description: 'The total number of file and directory entities visited in this backup. Only applicable to file based backups.' type: - integer - 'null' format: int64 x-go-name: TotalEntityCount totalLogicalBackupSizeBytes: description: 'Logical size of the source whose snapshot is being taken. This is the amount of data we would have read from the source had this been a full backup.' type: - integer - 'null' format: int64 x-go-name: TotalLogicalBackupSizeBytes totalPrimaryPhysicalSizeBytes: description: 'Contains the information regarding number of bytes that the source (such as VM) has taken up on the primary storage.' type: - integer - 'null' format: int64 x-go-name: TotalPrimaryPhysicalSizeBytes type: description: The type of environment this snapshot info pertains to. type: - integer - 'null' format: int32 x-go-name: Type viewCaseInsensitivityAltered: description: 'Whether during the backup, the backup view''s case insensitivity property has been altered. If so, Madrox needs to take corresponding actions during replication.' type: - boolean - 'null' x-go-name: ViewCaseInsensitivityAltered viewName: description: 'The view name under which the snapshot was created. NOTE: This is populated only for View, Puppeteer, NAS and Oracle backup.' type: - string - 'null' x-go-name: ViewName viewNameToGc: description: 'The view name under which the snapshot of the migrated data was created. NOTE: This is populated only for data migration tasks.' type: - string - 'null' x-go-name: ViewNameToGc warnings: description: Warnings if any. These warnings will be propogated to the UI by master. type: - array - 'null' items: $ref: '#/components/schemas/ErrorProto' x-go-name: Warnings x-go-package: magneto/base/magneto.pb ArchivalTarget: description: 'Message that specifies the details about an archival target (such as cloud or tape) where backup snapshots may be archived to.' type: object properties: name: description: The name of the archival target. type: - string - 'null' x-go-name: Name type: description: The type of the archival target. type: - integer - 'null' format: int32 x-go-name: Type vaultId: description: The id of the archival vault. type: - integer - 'null' format: int64 x-go-name: VaultId x-go-package: magneto/base/policy.pb FileUptieringParams: type: object title: File Uptiering Parameters for NAS migration. properties: fileSelectPolicy: description: File uptier policy based on file access/modify time. type: - integer - 'null' format: int32 x-go-name: FileSelectPolicy fileSize: description: 'Gives the size criteria to be used for selecting the files to be uptiered. The hot files, which are greater or smaller than file_size, are uptiered.' type: - integer - 'null' format: int64 x-go-name: FileSize fileSizePolicy: description: File size policy for selecting files to uptier. type: - integer - 'null' format: int32 x-go-name: FileSizePolicy hotFileWindow: description: 'Identifies the hot files in the view. Files which are accessed num_file_access times in hot_file_window msecs, are uptiered. It is only applicable when file_select_policy is kLastAccessed and num_file_access is greater than 1.' type: - integer - 'null' format: int64 x-go-name: HotFileWindow nfsMountPath: description: 'Mount path where the Cohesity target view is mounted on NFS clients while migrating the data.' type: - string - 'null' x-go-name: NfsMountPath numFileAccess: description: 'Number of times file must be accessed within hot_file_window in order to qualify for uptiering. Applicable only when file_select_policy is kLastAccessed.' type: - integer - 'null' format: uint32 x-go-name: NumFileAccess sourceViewName: description: The source view name from which the data will be uptiered. type: - string - 'null' x-go-name: SourceViewName uptierAllFiles: description: 'If set, all files in the view will be uptiered regardless of file_select_policy, num_file_access, hot_file_window, file_size constraints.' type: - boolean - 'null' x-go-name: UptierAllFiles x-go-package: magneto/base/env_params.pb CompareADObjectsResult_ADObject: type: object title: Represents an AD object record returned from object compare. properties: attributeVec: description: 'Array of AD attributes of AD object. This will contain distinct attributes from source and destination objects.' type: - array - 'null' items: $ref: '#/components/schemas/CompareADObjectsResult_ADAttribute' x-go-name: AttributeVec destGuid: description: 'Object guid from dest_server. If empty, compare could not find an AD object corresponding to ''source_guid'' even after looking up based on source_guid, source DN or source SAM account name. The SAM is applicable only for account type objects.' type: - string - 'null' x-go-name: DestGuid destPropCount: description: 'Number of attributes in destination object including system properties compared. This count is useful for debugging.' type: - integer - 'null' format: uint32 x-go-name: DestPropCount excludedPropCount: description: 'Number of attributes not compared due to ADCompareOptionFlags.kExcludeSysProps. This count is useful for debugging.' type: - integer - 'null' format: uint32 x-go-name: ExcludedPropCount mismatchPropCount: description: 'Number of AD attributes compared based on ''ADCompareOptionFlagsType'' flags and found to be mismatched. If this is non-zero, compared objects are different. If this is 0 ann''dest_guid'' is empty, then object is missing.' type: - integer - 'null' format: uint32 x-go-name: MismatchPropCount objectFlags: description: Object result flags of type ADObjectFlags. type: - integer - 'null' format: uint32 x-go-name: ObjectFlags sourceGuid: description: Object guid from $SourceServer. Guid string with or without '{}' braces. type: - string - 'null' x-go-name: SourceGuid sourcePropCount: description: 'Number of attributes in source object including system properties compared. This count is useful for debugging.' type: - integer - 'null' format: uint32 x-go-name: SourcePropCount status: description: 'Error status for object. This status will be set to ''kNotFound'' when source_guid or dest_guid could not be resolved. To find out whether destination object is missing, use flag ''ADObjectFlags.kDestinationNotFound''.' $ref: '#/components/schemas/ErrorProto' x-go-package: magneto/agents/windows/stub/ad_param.pb ViewParams: type: object title: Contains information needed when creating or cloning a view. properties: clientSubnetWhitelistVec: description: 'List of external client subnets from where requests will be received for the new view.' type: - array - 'null' items: $ref: '#/components/schemas/ClusterConfigProto_Subnet' x-go-name: ClientSubnetWhitelistVec disableNfsAccess: description: Whether to disable NFS access in the new view. type: - boolean - 'null' x-go-name: DisableNfsAccess protocolAccessInfo: description: The protocol access override (if any) of the view. $ref: '#/components/schemas/ViewIdMappingProto_ProtocolAccessInfo' qosMappingVec: description: The qos mappings (if any) for the new view. type: - array - 'null' items: $ref: '#/components/schemas/ClusterConfigProto_QoSMapping' x-go-name: QosMappingVec storagePolicyOverride: description: The storage policy override (if any) for the new view. $ref: '#/components/schemas/ClusterConfigProto_StoragePolicyOverride' viewDescription: description: The description to be applied to the new view. type: - string - 'null' x-go-name: ViewDescription wormLockExpiryUsecs: description: 'This value ''worm_lock_expiry_usecs'' if specified will be set on the cloned view. This guarantees that the cloned view cannot be removed till the specified timestamp has reached. NOTE: If this is specified the clone view will be marked as immutable.' type: - integer - 'null' format: int64 x-go-name: WormLockExpiryUsecs x-go-package: magneto/master/base/master.pb RestoreO365PublicFoldersParams_PublicFolder: description: Proto to capture the restore details of a Public Folder type: object properties: absoluteFolderPath: description: The absolute path of the folder. type: - string - 'null' x-go-name: AbsoluteFolderPath folderId: description: The Unique ID of the folder. type: - string - 'null' x-go-name: FolderId isEntireFolderRequired: description: Specify if the entire Public Folder is to be restored. type: - boolean - 'null' x-go-name: IsEntireFolderRequired itemIdVec: description: 'If is_entire_folder_required is set to false, users will then specify which particular items are to be restored.' type: - array - 'null' items: type: string x-go-name: ItemIdVec x-go-package: magneto/base/magneto.pb RestoreFileResultInfo: description: 'This message captures result of restore of individual file or directory as initiated from magneto. Note, it is expected that the agents go through the "estimation" phase first for the entire batch of restore requests and then start copying. These state transitions are reflected in the "status" field here.' type: object properties: copyStats: description: 'This captures the copy stats for this file and is present when the status is kInProgress.' $ref: '#/components/schemas/RestoreFileCopyStats' destinationDir: description: 'This is set to the destination directory where the file/directory was copied.' type: - string - 'null' x-go-name: DestinationDir error: description: This is set if there is any error during the restore. $ref: '#/components/schemas/ErrorProto' restoredFileInfo: description: 'Information of the file being restored. Note, the agent does not need to populate this.' $ref: '#/components/schemas/RestoredFileInfo' status: description: Status of the restore. type: - integer - 'null' format: int32 x-go-name: Status x-go-package: magneto/base/magneto.pb RestoreTaskAdditionalParams: description: 'Message to encapsulate the additional parameters associated with a restore task.' type: object properties: postScript: description: Post-script that must be executed after finishing the restore. $ref: '#/components/schemas/RemoteScriptProto' preScript: description: Pre-script that must be executed before starting the restore. $ref: '#/components/schemas/RemoteScriptProto' x-go-package: magneto/base/magneto.pb RecoverVirtualDiskInfoProto: description: 'Each available extension is listed below along with the location of the proto file (relative to magneto/connectors) where it is defined. RecoverVirtualDiskInfoProto extension Location ============================================================================= =============================================================================' type: object title: 'Message that encapsulates information about recover virtual disks task for any of the environments we support. Environment specific virtual disk infos are defined as extensions to this proto.' properties: cleanupError: description: 'If an error is encountered while cleaning up state, then it will be captured as part of this.' $ref: '#/components/schemas/ErrorProto' dataMigrationError: description: 'If an error was encountered while migrating the disks it will be captured here.' $ref: '#/components/schemas/ErrorProto' error: description: 'If recovering of disks failed, this field may contain the cause of the failure.' $ref: '#/components/schemas/ErrorProto' finished: description: This will be set to true if the task is complete on the slave. type: - boolean - 'null' x-go-name: Finished instantRecoveryFinished: description: 'This will be set to true once the instant recovery of the virtual disk is complete.' type: - boolean - 'null' x-go-name: InstantRecoveryFinished migrateTaskMoref: description: The task moref of the migrate job. $ref: '#/components/schemas/MORef' restoreDisksTaskInfoProto: description: 'The environment specific extensions of this proto store the detailed status information about the task.' title: 'The state of the task that sets up and tears down the restore disks that are needed during the mount/teardown operation' $ref: '#/components/schemas/SetupRestoreDiskTaskInfoProto' slaveTaskStartTimeUsecs: description: This is the timestamp at which the slave task started. type: - integer - 'null' format: int64 x-go-name: SlaveTaskStartTimeUsecs taskState: description: The state of the task. type: - integer - 'null' format: int32 x-go-name: TaskState type: description: The type of environment this recover virtual disk info pertains to. type: - integer - 'null' format: int32 x-go-name: Type x-go-package: magneto/base/magneto.pb RestoreOutlookParams_Folder: description: This will be set in case of partial mailbox recovery. type: object title: Defining Folder proto-message. properties: folderId: description: The Unique ID of the folder. type: - string - 'null' x-go-name: FolderId folderKey: description: The Unique key of the folder. type: - integer - 'null' format: int64 x-go-name: FolderKey isEntireFolderRequired: description: Specify if the entire folder is to be restored. type: - boolean - 'null' x-go-name: IsEntireFolderRequired itemIdVec: description: 'If is_entire_folder_required is set to false, user will then specify which particular items are to be restored.' type: - array - 'null' items: type: string x-go-name: ItemIdVec x-go-package: magneto/base/magneto.pb RestoreAppObjectParams: type: object title: Message for application object restore params. properties: adRestoreParams: description: 'The AD specific application object restore params. Only applicable if the RestoreAppObject.app_entity is of type kAD.' $ref: '#/components/schemas/RestoreADAppObjectParams' cloneTaskId: description: Id of finished clone task which has to be refreshed with different data. type: - integer - 'null' format: int64 x-go-name: CloneTaskId exchangeRestoreParams: description: 'The Exchange specific application object restore params. Only applicable if the RestoreAppObject.app_entity is of type kExchange.' $ref: '#/components/schemas/RestoreExchangeParams' oracleRestoreParams: description: 'Note: Only one of sql_restore_params and oracle_restore_params can be set.' title: 'The Oracle specific application object restore params. Only applicable if the RestoreAppObject.app_entity is of type kOracle.' $ref: '#/components/schemas/RestoreOracleAppObjectParams' sqlRestoreParams: description: 'The SQL specific application object restore params. Only applicable if the RestoreAppObject.app_entity is of type kSQL.' $ref: '#/components/schemas/RestoreSqlAppObjectParams' targetHost: description: 'The target host if the application is to be restored to a different host. If this is empty, then we are restoring to the original host, which is the owner entity.' $ref: '#/components/schemas/EntityProto' targetHostParentSource: description: 'The registered source managing the target host. If this is empty, then the target host has the same parent source as the owner entity.' $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/magneto.pb MountVolumeResult: type: object title: This message captures result of mount of an individual volume. properties: error: description: This is set if there is any error during the mount. $ref: '#/components/schemas/ErrorProto' filesystemType: description: Filesystem on this volume. type: - string - 'null' x-go-name: FilesystemType mountPoint: description: 'This is populated with the mount point where the volume corresponding to the newly attached volume is mounted. NOTE: This may not be present in the VM environments if onlining of disks is not requested or if the there was any issue during onlining.' type: - string - 'null' x-go-name: MountPoint originalVolumeName: description: This is the name or mount point of the original volume. type: - string - 'null' x-go-name: OriginalVolumeName x-go-package: magneto/base/magneto.pb MagnetoInstanceId: type: object properties: attemptNum: description: The attempt of the job instance that took the snapshot. type: - integer - 'null' format: int64 x-go-name: AttemptNum jobInstanceId: description: Instance of the job that took the snapshot. type: - integer - 'null' format: int64 x-go-name: JobInstanceId jobStartTimeUsecs: description: Start time of the job instance. type: - integer - 'null' format: int64 x-go-name: JobStartTimeUsecs x-go-package: yoda/base/yoda_types.pb MountVolumesHyperVParams: type: object title: HyperV specific additional params. properties: bringDisksOnline: description: 'Optional setting which will determine if the volumes need to be onlined within the target environment after attaching the disks. NOTE: If this is set to true, then target_entity_credentials must be specified and HyperV Integration Services must be installed on the VM.' type: - boolean - 'null' x-go-name: BringDisksOnline targetEntityCredentials: description: 'Credentials to access the target entity such as a VM. This is not required if bring_disks_online is set to false.' $ref: '#/components/schemas/Credentials' x-go-package: magneto/base/magneto.pb KeystoneACLProto: description: 'Protobuf that describes the Keystone access control list (ACL) permissions for a swift container. Note: Keystone ACL is applicable for only keystone authenticated users.' type: object properties: readGrantees: description: Grantees with read permission. $ref: '#/components/schemas/KeystoneACLProto_Grantees' writeGrantees: description: Grantees with write permission. $ref: '#/components/schemas/KeystoneACLProto_Grantees' x-go-package: bridge/s3_portal/base/s3_metadata.pb ADRestoreStatus: description: 'Represents AD restore status for object/attribute recovery. Each ADRestoreStatus entry will contain object_info: information about the object getting restored and status: status of the restore operation. object_info is used to generate the audit information of the AD restore operations.' type: object properties: objectInfo: description: 'The audit information about the AD object which was being recovered. This field will contain values like name,objectGUID,DN,objectClass and this information is used by the UI to show the audit information.' $ref: '#/components/schemas/CompareADObjectsResult_ADObject' status: description: 'Status object for AD objects/attributes for which the restores were done. This is an echo of the restore status sent by the agent for restore RPC call.' $ref: '#/components/schemas/ADObjectRestoreStatus' x-go-package: magneto/base/magneto.pb PerformRestoreJobStateProto_RestoreTask: description: 'Information of the object being restored along with the info of the task tracking the restore of that object.' type: object properties: object: description: 'Information of the object being restored (along with the snapshot it is being restored from).' $ref: '#/components/schemas/RestoreObject' objectProgressMonitorTaskPath: description: 'The relative task path of the progress monitor for the restore of the above ''object''. Please note that this field will be set only after progress monitor is created for this restore job.' type: - string - 'null' x-go-name: ObjectProgressMonitorTaskPath taskId: description: Id of the task tracking the restore of the above 'object'. type: - integer - 'null' format: int64 x-go-name: TaskId x-go-package: magneto/master/base/master.pb ViewIdMappingProto_FileLevelDataLockConfig: type: object title: File level data lock configuration. properties: autoLockDurationUsecs: description: 'Auto-lock automatically commit files to WORM state in the filesystem if they have not been modified for an administrator-specified period of time. When the auto-lock is enabled, this field must be set to idle time duration after which file would be automatically locked. Auto locking will be disabled when configured with default value of -1.' type: - integer - 'null' format: int64 x-go-name: AutoLockDurationUsecs defaultRetentionDurationUsecs: description: 'Default retention duration is used when an explicit retention timestamp is not set by user/application when locking a file. If the administrator does not want to enforce this, this field must not be set. If file requires being retained forever by default, this must be set to INT64_MAX. If minimum and maximum retention are enforced, then this must be always between these two durations.' type: - integer - 'null' format: int64 x-go-name: DefaultRetentionDurationUsecs holdTimestampUsecs: description: 'Specifies timestamp to protect locked files until a specific date. This would override retention periods and deny any mutable or remove operations on locked files until a specific date.' type: - integer - 'null' format: int64 x-go-name: HoldTimestampUsecs maxRetentionDurationUsecs: description: 'Specifies maximum retention duration of worm locked file. If the administrator does not want to enforce this, this must not be set. If default and max retention duration are enforced, max retention duration must be greater than or equal to default retention duration. If min and max retention duration are enforced, max retention duration must be greater than and equal to min retention duration.' type: - integer - 'null' format: int64 x-go-name: MaxRetentionDurationUsecs minRetentionDurationUsecs: description: 'Minimum and maximum retention duration allow the administrator to enforce retention duration that falls within a specified range. If the administrator does not want to enforce this, this must not be set. If the file requires being retained forever, this must be set to INT64_MAX. If default retention is enforced, this must be less than or equal to default retention. If max retention are enforced, default retention duration must be less than and equal to max retention duration.' type: - integer - 'null' format: int64 x-go-name: MinRetentionDurationUsecs mode: description: Explicit locking mode. type: - integer - 'null' format: int32 x-go-name: Mode protocol: description: Explicit locking protocol. type: - integer - 'null' format: int32 x-go-name: Protocol x-go-package: bridge/view_keeper/view_metadata.pb AWSFleetParams_NetworkParamsMapEntry: type: object properties: key: type: - string - 'null' x-go-name: Key value: $ref: '#/components/schemas/AWSFleetParams_NetworkParams' x-go-package: magneto/base/entities/aws.pb AzureManagedDiskParams: description: 'Contains managed disk parameters needed to deploy to Azure using managed disk.' type: object properties: dataDisksSkuType: description: SKU type for data disks. type: - integer - 'null' format: int32 x-go-name: DataDisksSkuType osDiskSkuType: description: SKU type for OS disk. type: - integer - 'null' format: int32 x-go-name: OsDiskSkuType x-go-package: magneto/base/cloud_deploy.pb CloneAppViewInfoProto: description: 'This message encapsulates the information of Clone operation of backup view of an App.' type: object properties: oracleAppViewRestoreInfo: $ref: '#/components/schemas/CloneAppViewInfoOracle' x-go-package: magneto/base/magneto.pb MountVolumesInfoProto: description: 'Each available extension is listed below along with the location of the proto file (relative to magneto/connectors) where it is defined. MountVolumesInfoProto extension Location ============================================================================= vmware::MountVolumesInfoProto::vmware_mount_volumes_info vmware/vmware.proto =============================================================================' type: object title: 'Message that encapsulates information about mount volumes task for any of the environments we support. Environment specific mount volume infos are defined as extensions to this proto.' properties: cleanupError: description: 'If an error is encountered while cleaning up state, then it will be captured as part of this.' $ref: '#/components/schemas/ErrorProto' error: description: 'If the mounting of volumes failed, this field may contain the cause of the failure.' $ref: '#/components/schemas/ErrorProto' finished: description: This will be set to true if the task is complete on the slave. type: - boolean - 'null' x-go-name: Finished mountVolumeResultVec: description: Contains the result information of the mounted volumes. type: - array - 'null' items: $ref: '#/components/schemas/MountVolumeResult' x-go-name: MountVolumeResultVec restoreDisksTaskInfoProto: description: 'The environment specific extensions of this proto store the detailed status information about the task.' title: 'The state of the task that sets up and tears down the restore disks that are needed during the mount/teardown operation' $ref: '#/components/schemas/SetupRestoreDiskTaskInfoProto' slaveTaskStartTimeUsecs: description: This is the timestamp at which the slave task started. type: - integer - 'null' format: int64 x-go-name: SlaveTaskStartTimeUsecs type: description: The type of environment this mount volumes info pertains to. type: - integer - 'null' format: int32 x-go-name: Type vmOnlineDisksError: description: 'If an error was encountered while onlining the disks within the VM, then this will capture that error. This is only applicable to the VMware environment.' $ref: '#/components/schemas/ErrorProto' x-go-package: magneto/base/magneto.pb VolumeInfo: type: object title: Information about each logical volume (filesystem). properties: diskVec: description: 'Information about all the disks and partitions needed to mount this logical volume.' type: - array - 'null' items: $ref: '#/components/schemas/VolumeInfo_DiskInfo' x-go-name: DiskVec displayName: description: Display name. type: - string - 'null' x-go-name: DisplayName filesystemType: description: Filesystem on this volume. type: - string - 'null' x-go-name: FilesystemType fsLabel: description: Filesystem label. type: - string - 'null' x-go-name: FsLabel fsUuid: description: Filesystem uuid. type: - string - 'null' x-go-name: FsUuid isBootable: description: Is this volume bootable? type: - boolean - 'null' x-go-name: IsBootable isDedup: description: 'Is this a dedup volume? Currently, set to true only for ntfs dedup volume.' type: - boolean - 'null' x-go-name: IsDedup isSupported: description: Is this a supported Volume (filesystem)? type: - boolean - 'null' x-go-name: IsSupported lvInfo: description: This field is set only for lvm and ldm volume only. $ref: '#/components/schemas/VolumeInfo_LogicalVolumeInfo' volumeGuid: description: 'The guid of the volume represented by this virtual disk. This information will be originally populated by magneto for physical environments.' type: - string - 'null' x-go-name: VolumeGuid volumeType: description: Whether this volume is simple, lvm or ldm. type: - integer - 'null' format: int32 x-go-name: VolumeType x-go-package: yoda/base/volume_info.pb AzureParams: description: Specifies various resources when converting and deploying a VM to Azure. type: object title: Azure Parameters. properties: dataDiskType: description: 'Specifies the disk type used by the data. ''kPremiumSSD'' is disk type backed by SSDs, delivers high performance, low latency disk support for VMs running I/O intensive workloads. ''kStandardSSD'' implies disk type that offers more consistent performance and reliability than HDD. ''kStandardHDD'' implies disk type backed by HDDs, delivers cost effective storage.' type: - string - 'null' enum: - kPremiumSSD - kStandardSSD - kStandardHDD x-go-name: DataDiskType instanceId: description: 'Specifies Type of VM (e.g. small, medium, large) when cloning the VM in Azure.' type: - integer - 'null' format: int64 x-go-name: InstanceId networkResourceGroupId: description: Specifies id of the resource group for the selected virtual network. type: - integer - 'null' format: int64 x-go-name: NetworkResourceGroupId osDiskType: description: 'Specifies the disk type used by the OS. ''kPremiumSSD'' is disk type backed by SSDs, delivers high performance, low latency disk support for VMs running I/O intensive workloads. ''kStandardSSD'' implies disk type that offers more consistent performance and reliability than HDD. ''kStandardHDD'' implies disk type backed by HDDs, delivers cost effective storage.' type: - string - 'null' enum: - kPremiumSSD - kStandardSSD - kStandardHDD x-go-name: OsDiskType resourceGroup: description: 'Specifies id of the Azure resource group. Its value is globally unique within Azure.' type: - integer - 'null' format: int64 x-go-name: ResourceGroup storageAccount: description: 'Specifies id of the storage account that will contain the storage container within which we will create the blob that will become the VHD disk for the cloned VM.' type: - integer - 'null' format: int64 x-go-name: StorageAccount storageContainer: description: Specifies id of the storage container within the above storage account. type: - integer - 'null' format: int64 x-go-name: StorageContainer storageResourceGroupId: description: Specifies id of the resource group for the selected storage account. type: - integer - 'null' format: int64 x-go-name: StorageResourceGroupId subnetId: description: Specifies Id of the subnet within the above virtual network. type: - integer - 'null' format: int64 x-go-name: SubnetId tempVmResourceGroupId: description: Specifies the resource group where temporary VM needs to be created. type: - integer - 'null' format: int64 x-go-name: TempVmResourceGroupId tempVmStorageAccountId: description: Specifies the Storage account where temporary VM needs to be created. type: - integer - 'null' format: int64 x-go-name: TempVmStorageAccountId tempVmStorageContainerId: description: Specifies the Storage container where temporary VM needs to be created. type: - integer - 'null' format: int64 x-go-name: TempVmStorageContainerId tempVmSubnetId: description: Specifies the Subnet where temporary VM needs to be created. type: - integer - 'null' format: int64 x-go-name: TempVmSubnetId tempVmVirtualNetworkId: description: Specifies the Virtual network where temporary VM needs to be created. type: - integer - 'null' format: int64 x-go-name: TempVmVirtualNetworkId virtualNetworkId: description: Specifies Id of the Virtual Network. type: - integer - 'null' format: int64 x-go-name: VirtualNetworkId x-go-package: cohesity/iris/server/data/public RestoreOracleAppObjectParams_AlternateLocationParams: description: 'For restoring to alternate location this message can not be empty and all the fields inside the message also can not be empty.' type: object properties: baseDir: description: 'Base directory of Oracle at destination. Example : /u01/app/oracle' type: - string - 'null' x-go-name: BaseDir databaseFileDestination: description: Location to put the database files(datafiles, logfiles etc.). type: - string - 'null' x-go-name: DatabaseFileDestination homeDir: description: 'Home directory of Oracle at destination. Example : /u01/app/oracle/product/11.2.0.3/db_1' type: - string - 'null' x-go-name: HomeDir newDatabaseName: description: The name of the Oracle database that we restore to. type: - string - 'null' x-go-name: NewDatabaseName newSidDeprecated: description: 'Deprecated field SID of new Oracle database.' type: - string - 'null' x-go-name: NewSidDeprecated oracleDbConfig: description: Alternate DB config override. $ref: '#/components/schemas/OracleDBConfig' x-go-package: magneto/base/magneto.pb StorageSnapshotProviderParams: type: object properties: connectorParams: description: Connector params to access the storage snapshot provider. $ref: '#/components/schemas/ConnectorParams' entity: description: The entity representing the storage snapshot provider. $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/magneto.pb OracleVlanInfo: type: object title: Message to capture Cohesity cluster vlan info for Oracle workflow. properties: gateway: description: Gateway for this VLAN. type: - string - 'null' x-go-name: Gateway id: description: ID of this VLAN. type: - integer - 'null' format: int32 x-go-name: Id ipVec: description: List of IPs in this VLAN. type: - array - 'null' items: type: string x-go-name: IpVec subnetIp: description: Subnet IP for this VLAN. type: - string - 'null' x-go-name: SubnetIp x-go-package: magneto/base/env_params.pb CloudDeployTarget: description: 'Message that specifies the details about CloudDeploy target where backup snapshots may be converted and stored.' type: object properties: deployVmsToCloudParams: description: 'Note that only the id field would be set for all the entities in DeployVMsToCloudParams. This is ok as we don''t replicate the policy to remote cluster currently. When we decide to replicate the policy to remote clusters, we need to populate the remaining fields.' title: 'Contains information needed to identify various resources when deploying VMs to Cloud.' $ref: '#/components/schemas/DeployVMsToCloudParams' targetEntity: description: 'Although we use EntityProto here, only the id field would be set in this proto. This is ok as we don''t replicate the policy to remote cluster currently. When we decide to replicate the policy to remote clusters, we need to populate the remaining fields.' title: Entity corresponding to the cloud deploy target. $ref: '#/components/schemas/EntityProto' type: description: The type of the CloudDeploy target. type: - integer - 'null' format: int32 x-go-name: Type x-go-package: magneto/base/policy.pb Links: description: 'The links proto to a specific resource. For example, resource, can be domain, endpoint or service.' type: object properties: next: type: - string - 'null' x-go-name: Next previous: type: - string - 'null' x-go-name: Previous self: type: - string - 'null' x-go-name: Self x-go-package: bridge/s3_portal/keystone/keystone2.pb RestoreAcropolisVMsParams: type: object title: This message defines the Acropolis specific VMs restore params. properties: powerStateConfig: description: 'Semantics for kRecoverVMs task: By default, VMs are restored in their original power state. This proto can be used to override the default behavior for the restore task.' title: The power state configuration to be applied to the restored VM. $ref: '#/components/schemas/PowerStateConfigProto' renameRestoredObjectParam: description: 'By default, VMs are restored with their original name. This field can be used to specify the transformation ( i.e prefix/suffix) to be applied to the source VM name to derive the new name of the restored VM.' $ref: '#/components/schemas/RenameObjectParamProto' restoredObjectsNetworkConfig: description: 'Semantics for kRecoverVMs task: By default, if the VMs are being restored to their original location, then original network configuration will be preserved. If objects are being restored to different location (i.e., different parent source), then network will be detached. Below field can be used to override the default network configuration of the restored VMs. If user want to keep the original network setting for kRecoverVMs task, then this proto should not be set.' title: The network configuration to be applied to the restored VMs. $ref: '#/components/schemas/RestoredObjectNetworkConfigProto' storageContainer: description: 'A storage container where the VM''s files should be restored to. This field is optional if the VM is being restored to its original parent source. If not specified, the VM''s files will be restored to their original storage container(s). This field is mandatory if the VMs are being restored to a different parent source.' $ref: '#/components/schemas/EntityProto' uuidConfig: description: 'Semantics for kRecoverVMs task: By default, recovered VMs have new UUIDs for them. This proto can be used to override the default behavior for the restore task.' title: UUID config to use for restored VM. $ref: '#/components/schemas/UuidConfigProto' x-go-package: magneto/base/magneto.pb RestoreFilesParams_DirectoryNameSecurityStyleMapEntry: type: object properties: key: type: - string - 'null' x-go-name: Key value: type: - string - 'null' x-go-name: Value x-go-package: magneto/base/magneto.pb RestoreFilesTaskStateProto: type: object title: Persistent state for a "restore files" task. properties: restoreFilesInfo: description: 'Contains information about this restore files task that is populated by the slave.' $ref: '#/components/schemas/RestoreFilesInfoProto' restoreParams: description: 'This captures all the necessary information required to perform restore to source task.' $ref: '#/components/schemas/RestoreFilesParams' x-go-package: magneto/master/base/master.pb RestoreOneDriveParams_DriveOwner: type: object properties: driveVec: description: The list of drives that are being restored. type: - array - 'null' items: $ref: '#/components/schemas/RestoreOneDriveParams_DriveOwner_Drive' x-go-name: DriveVec object: description: This will store the details of the user whose drive is to be restored. $ref: '#/components/schemas/RestoreObject' x-go-package: magneto/base/magneto.pb RestoreFilesPreferences: description: 'This message captures preferences from the user while restoring the files on the target.' type: object properties: alternateRestoreBaseDirectory: description: 'This must be set to a directory path if restore_to_original_paths is false. All the files and directories restored will be restored under this location.' type: - string - 'null' x-go-name: AlternateRestoreBaseDirectory continueOnError: description: Whether to continue with the copy in case of encountering an error. type: - boolean - 'null' x-go-name: ContinueOnError encryptionEnabled: description: Whether to enable encryption for NFS and SMB restores. type: - boolean - 'null' x-go-name: EncryptionEnabled generateSshKeys: description: 'In case of GCP Linux restores, whether to generate ssh keys to connect to the customer''s instance.' type: - boolean - 'null' x-go-name: GenerateSshKeys overrideOriginals: description: 'This is relevant only if restore_to_original_paths is true. If this is true, then already existing files will be overridden, otherwise new files will be skipped.' type: - boolean - 'null' x-go-name: OverrideOriginals preserveAcls: description: Whether to preserve the ACLs of the original file. type: - boolean - 'null' x-go-name: PreserveAcls preserveAttributes: description: Whether to preserve the original attributes. type: - boolean - 'null' x-go-name: PreserveAttributes preserveTimestamps: description: Whether to preserve the original time stamps. type: - boolean - 'null' x-go-name: PreserveTimestamps restoreToOriginalPaths: description: If this is true, then files will be restored to original paths. type: - boolean - 'null' x-go-name: RestoreToOriginalPaths skipEstimation: description: Whether to skip the estimation step. type: - boolean - 'null' x-go-name: SkipEstimation x-go-package: magneto/base/magneto.pb RestoreSiteParams: type: object title: This message defines the OneDrive specific restore params. properties: restoreToOriginal: description: Whether or not all sites are restored to original location. type: - boolean - 'null' x-go-name: RestoreToOriginal siteOwnerVec: description: The list of sites whose drives are being restored. type: - array - 'null' items: $ref: '#/components/schemas/RestoreSiteParams_SiteOwner' x-go-name: SiteOwnerVec targetDocLibName: description: 'Incase of alternate restore of granular items within document repositiories of sites to another site, a doc lib name has to be specified by the caller. NOTE: It can be safely assumed that this field will only be present in case of granular items restore only.' type: - string - 'null' x-go-name: TargetDocLibName targetDocLibPrefix: description: 'If alternate site is provided, customer may want to provide a custom prefix to document libraries that we create. In any case we would also have to distinguish the newly created document library as the alternate site provided by the customer may as well turn out to be the original backup site.' type: - string - 'null' x-go-name: TargetDocLibPrefix targetSite: description: This is the site in whose drive the items will be restored. $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/magneto.pb MagnetoObjectId: type: object title: Message that represents a Magneto object. Only used by Yoda. properties: entity: description: Entity proto that represents the object being snapshotted. $ref: '#/components/schemas/EntityProto' jobId: description: 'The id of the local job that the object belongs to, which may or may not match the object_id field in job_uid below depending on whether the object originally belonged to this local job or to a different remote job.' type: - integer - 'null' format: int64 x-go-name: JobId jobUid: description: 'The globally unique id of the job that the object originally belonged to. If this object originally belonged to a job from a remote cluster, this field will contain the uid of the remote job, else it will contain the uid of the local job.' $ref: '#/components/schemas/UniversalIdProto' x-go-package: magneto/base/magneto.pb responses: CreateCloneRefreshTaskResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/RestoreTaskWrapper' Error: description: Error content: application/json: schema: $ref: '#/components/schemas/RequestError'