openapi: 3.2.0 info: description: 'This API list provides operations for interfacing with the Cohesity Cluster.' title: Cohesity REST Restore Tasks API version: '1.0' servers: - url: https:///irisservices/api/v1 tags: - name: RestoreTasks paths: /public/restore/adDomainRootTopology: get: description: Returns the root topology for an AD domain. tags: - RestoreTasks summary: Gets Root Topology for an AD Domain operationId: GetAdDomainRootTopology parameters: - x-go-name: RestoreTaskId description: 'Specifies the restoreTaskId corresponding to which we need to get the ad topology.' name: restoreTaskId in: query required: true schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/GetAdDomainRootTopologyResponse' default: $ref: '#/components/responses/Error' /public/restore/adObjectAttributes: post: description: 'Returns the list of AD Objects after comparing attributes of AD Object from both Snapshot and Production AD.' tags: - RestoreTasks summary: Compares the AD Object from both Snapshot and Production AD and returns the… operationId: CompareAdObjects responses: '200': $ref: '#/components/responses/CompareAdObjectsResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/CompareAdObjectsRequest' description: 'Specifies the Request to compare the AD Objects from both Snapshot and Production AD.' required: true /public/restore/adObjects: get: description: 'Returns the list of AD Objects along with status whether they are missing in Production AD, equal or not equal.' tags: - RestoreTasks summary: Searches for AD Objects in both Production and Snapshot AD from given search… operationId: SearchAdObjects parameters: - x-go-name: RestoreTaskId description: 'Specifies the restoreTaskId corresponding to which we need to search AD objects.' name: restoreTaskId in: query required: true schema: type: integer format: int64 - x-go-name: NumObjects description: Specifies the number of AD Objects to be fetched. name: numObjects in: query schema: type: integer format: uint32 - x-go-name: SearchBaseDn description: 'Specifies the search base distinguished name from where the search should begin in the hierarchy of the AD in both Production and Snapshot AD.' name: searchBaseDn in: query schema: type: string - x-go-name: SubtreeSearchScope description: 'Specifies the search scope for the request. If subtree search scope is true all the children of Search Base DN are returned from given offset. If subtree search scope is false only all objects which are one level from the Search Base DN are returned.' name: subtreeSearchScope in: query schema: type: boolean - x-go-name: CompareObjects description: 'Specifies the option to compare the properties from Snapshot AD and Production AD if specifed and sets kNotEqual flag in the result when there is mismatch.' name: compareObjects in: query schema: type: boolean - x-go-name: ExcludeSystemProperties description: 'Specifies the option to exclude the system attributes while comparing the the objects from the Production AD and Snapshot AD.' name: excludeSystemProperties in: query schema: type: boolean - x-go-name: Filter description: 'Specifies the filter which can be used for searching the AD Objects from given Search Base DN. There are two types of filters supported. They are: 1) If the string does not contain LDAP delimiters ''('' and '')'', then it is assumed to be ANR search "(anr=)" Eg: "a" will result in query to return all ANR fields with "a" characters (case insensitive) in them 2) Search with OR and AND combination: "(|(&(objectClass=user)(distinguishedName=CN=Jone Doe,OU=Users,DC=corp,DC=cohesity,DC=com))(&(objectClass=user) (sAMAccountName=jdoe)))"' name: filter in: query schema: type: string - x-go-name: RecordOffset description: 'Specifies the offset from which AD objects should be searched in both the Snapshot and Production AD.' name: recordOffset in: query schema: type: integer format: uint32 responses: '200': $ref: '#/components/responses/SearchAdObjectsResponse' default: $ref: '#/components/responses/Error' post: description: 'Returns the list of AD Objects that match the list of object guids, sam account names and distinguished names provided in the request.' tags: - RestoreTasks summary: Searches for AD Objects that match the list of object guids, sam account names… operationId: SearchProductionAdObjects responses: '200': $ref: '#/components/responses/SearchAdObjectsResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchProductionAdObjectsRequest' description: Specifies the Request to search the AD Objects from Production AD. required: true /public/restore/adObjects/searchResults: get: description: 'Search for AD objects to recover that match the specified search and filter criterias provided in the request.' tags: - RestoreTasks operationId: GetAdObjects parameters: - x-go-name: Name description: Specifies the name of the AD object. name: name in: query schema: type: string - x-go-name: SamAccountName description: Specifies the sam account name of the AD object. name: samAccountName in: query schema: type: string - x-go-name: ObjectType description: 'Specifies the type of the AD Object. The type may be user, computer, group or ou(organizational unit).' name: objectType in: query schema: type: string - x-go-name: Email description: Specifies the email of the AD object of type user or group. name: email in: query schema: type: string - x-go-name: RegisteredSourceIds description: 'Specifies the Active Directory Application Server Ids which contains the AD objects.' name: registeredSourceIds in: query schema: type: array items: type: integer format: int64 - x-go-name: JobIds description: 'Specifies the protection job Ids which have backed up Active Directory Application Server.' name: jobIds in: query schema: type: array items: type: integer format: int64 - x-go-name: ViewBoxIds description: 'Filter by a list of Domains (View Boxes) ids. Only items stored in the listed Domains (View Boxes) are returned.' name: viewBoxIds in: query schema: type: array items: type: integer format: int64 - x-go-name: Domain description: domain of the AD object. name: domain in: query schema: type: string - x-go-name: TenantId description: TenantId specifies the tenant whose action resulted in the audit log. name: tenantId in: query schema: type: string - x-go-name: AllUnderHierarchy description: 'AllUnderHierarchy specifies if logs of all the tenants under the hierarchy of tenant with id TenantId should be returned.' name: allUnderHierarchy in: query schema: type: boolean responses: '200': $ref: '#/components/responses/SearchRestoredFilesResponse' default: $ref: '#/components/responses/Error' summary: Get ad objects x-summary-source: derived /public/restore/adObjects/status: get: description: 'Returns the Restore status of the AD objects which were restored from the snapshot AD to production AD as part of the restore task id specified in the parameters.' tags: - RestoreTasks operationId: AdObjectsRestoreStatus parameters: - x-go-name: RestoreTaskId description: 'Specifies the restoreTaskId corresponding to which we need to get information about the restore of the AD objects.' name: restoreTaskId in: query schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/AdObjectsRestoreStatusResponse' default: $ref: '#/components/responses/Error' summary: Ad objects restore status x-summary-source: derived /public/restore/applicationsClone: post: description: Returns the created Restore Task. tags: - RestoreTasks summary: Create a Restore Task for cloning Applications like SQL Databases operationId: CreateApplicationsCloneTask responses: '201': $ref: '#/components/responses/CreateCloneTaskResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicationsRestoreTaskRequest' description: Request to create a Restore Task for cloning Applications like SQL DB. required: true /public/restore/applicationsRecover: post: description: Returns the created Restore Task. tags: - RestoreTasks summary: Create a Restore Task for recovering Applications like SQL Databases operationId: CreateApplicationsRecoverTask responses: '201': $ref: '#/components/responses/CreateRecoverTaskResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicationsRestoreTaskRequest' description: 'Request to create a Restore Task for recovering Applications like SQL DB. volumes to mount points.' required: true /public/restore/clone: post: description: Returns the created Restore Task that clones VMs or a View. tags: - RestoreTasks summary: Create a Restore Task for cloning VMs or a View operationId: CreateCloneTask responses: '201': $ref: '#/components/responses/CreateCloneTaskResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/CloneTaskRequest' description: Request to create a Restore Task for cloning VMs or a View. required: true /public/restore/clone/{id}: delete: tags: - RestoreTasks summary: Destroy a clone task with specified id operationId: PublicDestroyCloneTask parameters: - x-go-name: Id description: Specifies a unique id of the Clone Task to destroy. name: id in: path required: true schema: type: integer format: int64 responses: '204': $ref: '#/components/responses/NoContentResponse' default: $ref: '#/components/responses/Error' /public/restore/deploy: post: description: 'Returns the created Restore Task that deploys VMs on cloud. This operation returns the target where cloud is deployed. Currently, VMs can be deployed in either AWS target or Azure target.' tags: - RestoreTasks summary: Create a Restore Task for deploying VMs or a View on cloud operationId: CreateDeployTask responses: '201': $ref: '#/components/responses/CreateDeployTaskResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/DeployTaskRequest' description: Request to create a Restore Task for deploying VMs or a View on cloud. required: true /public/restore/downloadFilesAndFolders: post: description: Returns the created download Task information that downloads files and folders. tags: - RestoreTasks summary: Create a Download Task for downloading files and folders operationId: CreateDownloadFilesAndFolders responses: '201': $ref: '#/components/responses/CreateDownloadFilesAndFoldersResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/DownloadFilesAndFoldersParams' description: 'Request to create a task for downloading list of files or folders.' required: true /public/restore/files: get: description: 'Use the files and folders returned by this operation to populate the list of files and folders to recover in the POST /public/restore/files operation. If no search pattern or filter parameters are specified, all files and folders currently found on the Cohesity Cluster are returned. Specify a search pattern or parameters to filter the results that are returned. The term "items" below refers to files and folders that are found in the source objects (such as VMs).' tags: - RestoreTasks summary: Search for files and folders to recover that match the specified search and… operationId: SearchRestoredFiles parameters: - x-go-name: MustHaveTags description: Specifies tags which must be all present in the document. name: mustHaveTags in: query schema: type: array items: type: string - x-go-name: MightHaveTags description: 'Specifies list of tags, one of which might be present in the document. These are OR''ed together and the resulting criteria AND''ed with the rest of the query.' name: mightHaveTags in: query schema: type: array items: type: string - x-go-name: MustHaveSnapshotTags description: Specifies snapshot tags which must be all present in the document. name: mustHaveSnapshotTags in: query schema: type: array items: type: string - x-go-name: MightHaveSnapshotTags description: 'Specifies list of snapshot tags, one of which might be present in the document. These are OR''ed together and the resulting criteria AND''ed with the rest of the query.' name: mightHaveSnapshotTags in: query schema: type: array items: type: string - x-go-name: Paginate description: 'Specifies bool to control pagination of search results. Only valid for librarian queries. If this is set to true and a pagination cookie is provided, search will be resumed.' name: paginate in: query schema: type: boolean - x-go-name: PageSize description: 'Specifies pagesize for pagination. Only valid for librarian queries. Effective only when Paginate is set to true.' name: pageSize in: query schema: type: integer format: int32 - x-go-name: PaginationCookie description: 'Specifies cookie for resuming search if pagination is being used. Only valid for librarian queries. Effective only when Paginate is set to true.' name: paginationCookie in: query schema: type: string - x-go-name: Search description: 'Filter by searching for sub-strings in the item name. The specified string can match any part of the item name. For example: "vm" or "123" both match the item name of "vm-123".' name: search in: query schema: type: string - x-go-name: JobIds description: 'Filter by a list of Protection Job ids. Only items backed up by the specified Jobs are listed.' name: jobIds in: query schema: type: array items: type: integer format: int64 - x-go-name: RegisteredSourceIds description: 'Filter by a list of Registered Sources ids. Only items from the listed Registered Sources are returned.' name: registeredSourceIds in: query schema: type: array items: type: integer format: int64 - x-go-name: ViewBoxIds description: 'Filter by a list of Domains (View Boxes) ids. Only items stored in the listed Domains (View Boxes) are returned.' name: viewBoxIds in: query schema: type: array items: type: integer format: int64 - x-go-name: Environments description: 'Filter by environment types such as ''kVMware'', ''kView'', etc. Only items from the specified environment types are returned. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter.' name: environments in: query schema: type: array items: enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kVCD - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kKubernetes - kElastifile type: string - x-go-name: StartTimeUsecs description: 'Filter by backup completion time by specifying a backup completion start and end times. Specified as a Unix epoch Timestamp (in microseconds). Only items created by backups that completed between the specified start and end times are returned.' name: startTimeUsecs in: query schema: type: integer format: int64 - x-go-name: EndTimeUsecs description: 'Filter by backup completion time by specify a backup completion start and end times. Specified as a Unix epoch Timestamp (in microseconds). Only items created by backups that completed between the specified start and end times are returned.' name: endTimeUsecs in: query schema: type: integer format: int64 - x-go-name: StartIndex description: 'Specifies an index number that can be used to return subsets of items in multiple requests. Break up the items to return into multiple requests by setting pageCount and using startIndex to return a subsets of items. For example, set startIndex to 0 to get the first set of items for the first request. Increment startIndex by pageCount to get the next set of items for a next request. Continue until all items are returned and therefore the total number of returned items is equal to totalCount.' name: startIndex in: query schema: type: integer format: int64 - x-go-name: PageCount description: 'Limit the number of items to return in the response for pagination purposes.' name: pageCount in: query schema: type: integer format: int64 - x-go-name: SourceIds description: 'Filter by source ids. Only files and folders found in the listed sources (such as VMs) are returned.' name: sourceIds in: query schema: type: array items: type: integer format: int64 - x-go-name: FolderOnly description: 'Filter by folders or files. If true, only folders are returned. If false, only files are returned. If not specified, both files and folders are returned.' name: folderOnly in: query schema: type: boolean - x-go-name: TenantId description: TenantId specifies the tenant whose action resulted in the audit log. name: tenantId in: query schema: type: string - x-go-name: AllUnderHierarchy description: 'AllUnderHierarchy specifies if logs of all the tenants under the hierarchy of tenant with id TenantId should be returned.' name: allUnderHierarchy in: query schema: type: boolean responses: '200': $ref: '#/components/responses/SearchRestoredFilesResponse' default: $ref: '#/components/responses/Error' post: description: Returns the created Restore Task that recovers files and folders. tags: - RestoreTasks summary: Create a Restore Task for recovering files and folders operationId: CreateRestoreFilesTask responses: '201': $ref: '#/components/responses/CreateRestoreFilesTaskResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/RestoreFilesTaskRequest' description: Request to create a Restore Task for recovering files or folders. required: true /public/restore/files/fstats: get: tags: - RestoreTasks summary: Get the fstat information about file provided using query parameters operationId: GetFileFstatInformation parameters: - x-go-name: JobId description: 'JobId is the id of the local job that took the snapshot, which may or may not match the JobUidObjectId below depending on whether the object originally belonged to this local job or to a different remote job.' name: jobId in: query required: true schema: type: integer format: int64 - x-go-name: JobUidObjectId description: 'JobUidObjectId is 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 JobId of the remote job, else it will contain the JobId of the local job.' name: jobUidObjectId in: query required: true schema: type: integer format: int64 - x-go-name: EntityId description: EntityId is the Id of the VM. name: entityId in: query required: true schema: type: integer format: int64 - x-go-name: JobInstanceId description: JobInstanceId is the Id of the job run that backed up the entity. name: jobInstanceId in: query required: true schema: type: integer format: int64 - x-go-name: JobStartTimeUsecs description: 'JobStartTimeUsecs is the start time in usecs of the job run that backed up the entity.' name: jobStartTimeUsecs in: query required: true schema: type: integer format: int64 - x-go-name: AttemptNum description: 'AttemptNum is the attempt number of the run that successfully created the snapshot.' name: attemptNum in: query schema: type: integer format: int64 - x-go-name: VolumeName description: 'VolumeName is the name of the volume that needs to be browsed. This should match the name returned in VolumeInfo.' name: volumeName in: query schema: type: string - x-go-name: ViewBoxId description: Id of the View Box if a View is being browsed. name: viewBoxId in: query schema: type: integer format: int64 - x-go-name: ViewName description: Name of the View if a View is being browsed. name: viewName in: query schema: type: string - x-go-name: VolumeInfoCookie description: 'VolumeInfoCookie is the cookie to be passed in calls to reading a VM dir for this volume.' name: volumeInfoCookie in: query schema: type: integer format: uint64 - x-go-name: FilePath description: FilePath is the full path of the file or directory whose stat needed. name: filePath in: query required: true schema: type: string - x-go-name: UseLibrarian description: 'Specifies whether to use Librarian for file stat. This will be true if the browse is enabled via librarian.' name: useLibrarian in: query schema: type: boolean responses: '200': $ref: '#/components/responses/GetFileFstatInformationResponse' default: $ref: '#/components/responses/Error' /public/restore/files/snapshotsInformation: get: tags: - RestoreTasks summary: Get the information about snapshots that contain the specified file or folder. operationId: GetFileSnapshotsInformation parameters: - x-go-name: JobId description: 'Specifies the id of the Job that captured the snapshots. These snapshots are searched for the specified files or folders. This field is required.' name: jobId in: query required: true schema: type: integer format: int64 - x-go-name: ClusterId description: 'Specifies the Cohesity Cluster id where the Job was created. This field is required.' name: clusterId in: query required: true schema: type: integer format: int64 - x-go-name: ClusterIncarnationId description: 'Specifies the incarnation id of the Cohesity Cluster where the Job was created. An incarnation id is generated when a Cohesity Cluster is initially created. This field is required.' name: clusterIncarnationId in: query required: true schema: type: integer format: int64 - x-go-name: SourceId description: 'Specifies the id of the Protection Source object (such as a VM) to search. When a Job Run executes, snapshots of the specified Protection Source object are captured. This operation searches the snapshots of the object for the file or folder. This field is required.' name: sourceId in: query required: true schema: type: integer format: int64 - x-go-name: Filename description: 'Specifies the name of the file or folder to find in the snapshots. This field is required.' name: filename in: query required: true schema: type: string responses: '200': $ref: '#/components/responses/GetFileSnapshotsInformationResponse' default: $ref: '#/components/responses/Error' /public/restore/objects: get: description: 'If no search pattern or filter parameters are specified, all backup objects currently found on the Cohesity Cluster are returned. Only leaf objects that have been protected by a Job are returned such as VMs, Views and databases. Specify a search pattern or parameters to filter the results that are returned. The term "items" below refers to leaf backup objects such as VMs, Views and databases.' tags: - RestoreTasks summary: Find backup objects that match the specified search and filter criteria on the… operationId: SearchObjects parameters: - x-go-name: Search description: 'Filter by searching for sub-strings in the item name. The specified string can match any part of the item name. For example: "vm" or "123" both match the item name of "vm-123".' name: search in: query schema: type: string - x-go-name: JobIds description: 'Filter by a list of Protection Job ids. Only items backed up by the specified Jobs are listed.' name: jobIds in: query schema: type: array items: type: integer format: int64 - x-go-name: RegisteredSourceIds description: 'Filter by a list of Registered Sources ids. Only items from the listed Registered Sources are returned.' name: registeredSourceIds in: query schema: type: array items: type: integer format: int64 - x-go-name: ViewBoxIds description: 'Filter by a list of Domains (View Boxes) ids. Only items stored in the listed Domains (View Boxes) are returned.' name: viewBoxIds in: query schema: type: array items: type: integer format: int64 - x-go-name: Environments description: 'Filter by environment types such as ''kVMware'', ''kView'', etc. Only items from the specified environment types are returned. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter.' name: environments in: query schema: type: array items: enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kVCD - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kKubernetes - kElastifile type: string - x-go-name: Office365SourceTypes description: 'Filter by Office365 types such as ''kUser'', ''kSite'', etc. Only items from the specified source types are returned.' name: office365SourceTypes in: query schema: type: array items: enum: - kDomain - kOutlook - kMailbox - kUsers - kGroups - kSites - kUser - kGroup - kSite type: string - x-go-name: StartTimeUsecs description: 'Filter by backup completion time by specifying a backup completion start and end times. Specified as a Unix epoch Timestamp (in microseconds). Only items created by backups that completed between the specified start and end times are returned.' name: startTimeUsecs in: query schema: type: integer format: int64 - x-go-name: EndTimeUsecs description: 'Filter by backup completion time by specify a backup completion start and end times. Specified as a Unix epoch Timestamp (in microseconds). Only items created by backups that completed between the specified start and end times are returned.' name: endTimeUsecs in: query schema: type: integer format: int64 - x-go-name: StartIndex description: 'Specifies an index number that can be used to return subsets of items in multiple requests. Break up the items to return into multiple requests by setting pageCount and using startIndex to return a subsets of items. For example, set startIndex to 0 to get the first set of items for the first request. Increment startIndex by pageCount to get the next set of items for a next request. Continue until all items are returned and therefore the total number of returned items is equal to totalCount.' name: startIndex in: query schema: type: integer format: int64 - x-go-name: PageCount description: 'Limit the number of items to return in the response for pagination purposes.' name: pageCount in: query schema: type: integer format: int64 - x-go-name: OperatingSystems description: 'Filter by the Operating Systems running on VMs and Physical Servers. This filter is applicable only to VMs and physical servers.' name: operatingSystems in: query schema: type: array items: type: string - x-go-name: Application description: 'Filter by application when the environment type is kSQL. For example, if SQL is specified the SQL databases are returned.' name: application in: query schema: type: string - x-go-name: OwnerEntityId description: 'Filter objects by the Entity id of the owner VM. For example, if a ownerEntityId is provided while searching for SQL databases, only SQL databases belonging to the VM with the specified id are returned. ownerEntityId is only significant if application is set to SQL.' name: ownerEntityId in: query schema: type: integer format: int64 - x-go-name: TenantId description: TenantId specifies the tenant whose action resulted in the audit log. name: tenantId in: query schema: type: string - x-go-name: AllUnderHierarchy description: 'AllUnderHierarchy specifies if logs of all the tenants under the hierarchy of tenant with id TenantId should be returned.' name: allUnderHierarchy in: query schema: type: boolean responses: '200': $ref: '#/components/responses/SearchObjectsResponse' default: $ref: '#/components/responses/Error' /public/restore/office365/onedrive/documents: get: description: 'Search for OneDrive files and folder to recover that match the specified search and filter criterias on the Cohesity cluster.' tags: - RestoreTasks summary: Returns the OneDrive files and folders operationId: GetOneDriveDocuments parameters: - x-go-name: TenantId description: TenantId specifies the tenant whose action resulted in the audit log. name: tenantId in: query schema: type: string - x-go-name: AllUnderHierarchy description: 'AllUnderHierarchy specifies if logs of all the tenants under the hierarchy of tenant with id TenantId should be returned.' name: allUnderHierarchy in: query schema: type: boolean - x-go-name: DocumentName description: Specifies the document(file/folder) name. name: documentName in: query schema: type: string - x-go-name: DomainIds description: Specifies the domain Ids in which Users' OneDrives are registered. name: domainIds in: query schema: type: array items: type: integer format: int64 - x-go-name: UserIds description: Specifies the Office365 User Ids which is teh owner of the OneDrive. name: mailboxIds in: query schema: type: array items: type: integer format: int64 - x-go-name: ProtectionJobIds description: 'Specifies the protection job Ids which have backed up mailbox(es) continaing emails/folders.' name: protectionJobIds in: query schema: type: array items: type: integer format: int64 responses: '200': $ref: '#/components/responses/SearchRestoredFilesResponse' default: $ref: '#/components/responses/Error' /public/restore/office365/outlook/emails: get: description: 'Search for Emails and Emails'' folders to recover that match the specified search and filter criterias on the Cohesity cluster.' tags: - RestoreTasks summary: Returns the Outlook emails and folders containing emails operationId: GetOutlookEmails parameters: - x-go-name: HasAttachments description: Specifies whether the emails have any attachments. name: hasAttachments in: query schema: type: boolean - x-go-name: SenderAddress description: Specifies the email address of the sender. name: senderAddress in: query schema: type: string - x-go-name: RecipientAddresses description: Specifies the email addresses of the recipients. name: recipientAddresses in: query schema: type: array items: type: string - x-go-name: CcRecipientAddresses description: Specifies the email addresses of the cc recipients. name: ccRecipientAddresses in: query schema: type: array items: type: string - x-go-name: BccRecipientAddresses description: Specifies the email addresses of the bcc recipients. name: bccRecipientAddresses in: query schema: type: array items: type: string - x-go-name: SentTimeSeconds description: Specifies the unix time when the email was sent. name: sentTimeSeconds in: query schema: type: integer format: int64 - x-go-name: ReceivedTimeSeconds description: Specifies the unix time when the email was received. name: receivedTimeSeconds in: query schema: type: integer format: int64 - x-go-name: ReceivedStartTime description: Specifies the unix start time for querying on email's received time. name: receivedStartTime in: query schema: type: integer format: int64 - x-go-name: ReceivedEndTime description: Specifies the unix end time for querying on email's received time. name: receivedEndTime in: query schema: type: integer format: int64 - x-go-name: EmailSubject description: Specifies the subject of the email. name: emailSubject in: query schema: type: string - x-go-name: FolderName description: Specifies the parent folder name of the email. name: folderName in: query schema: type: string - x-go-name: ShowOnlyEmailFolders description: Specifies whether the query result should include only Email folders. name: showOnlyEmailFolders in: query schema: type: boolean - x-go-name: DomainIds description: Specifies the domain Ids in which mailboxes are registered. name: domainIds in: query schema: type: array items: type: integer format: int64 - x-go-name: MailboxIds description: Specifies the mailbox Ids which contains the emails/folders. name: mailboxIds in: query schema: type: array items: type: integer format: int64 - x-go-name: ProtectionJobIds description: 'Specifies the protection job Ids which have backed up mailbox(es) continaing emails/folders.' name: protectionJobIds in: query schema: type: array items: type: integer format: int64 - x-go-name: TenantId description: TenantId specifies the tenant whose action resulted in the audit log. name: tenantId in: query schema: type: string - x-go-name: AllUnderHierarchy description: 'AllUnderHierarchy specifies if logs of all the tenants under the hierarchy of tenant with id TenantId should be returned.' name: allUnderHierarchy in: query schema: type: boolean responses: '200': $ref: '#/components/responses/SearchRestoredFilesResponse' default: $ref: '#/components/responses/Error' /public/restore/office365/sharepoint/documents: get: description: 'Search for Sharepoint files and folder to recover that match the specified search and filter criterias on the Cohesity cluster.' tags: - RestoreTasks summary: Returns the Sharepoint Site's files and folders operationId: GetSharepointDocuments parameters: - x-go-name: TenantId description: TenantId specifies the tenant whose action resulted in the audit log. name: tenantId in: query schema: type: string - x-go-name: AllUnderHierarchy description: 'AllUnderHierarchy specifies if logs of all the tenants under the hierarchy of tenant with id TenantId should be returned.' name: allUnderHierarchy in: query schema: type: boolean - x-go-name: DocumentName description: Specifies the document(file/folder) name. name: documentName in: query schema: type: string - x-go-name: DomainIds description: Specifies the domain Ids in which Sharepoint Site's are registered. name: domainIds in: query schema: type: array items: type: integer format: int64 - x-go-name: SiteIds description: Specifies the Office365 Sharepoint Site Id. name: siteIds in: query schema: type: array items: type: integer format: int64 - x-go-name: ProtectionJobIds description: 'Specifies the protection job Ids which have backed up sites containing the documents.' name: protectionJobIds in: query schema: type: array items: type: integer format: int64 responses: '200': $ref: '#/components/responses/SearchRestoredFilesResponse' default: $ref: '#/components/responses/Error' /public/restore/pointsForTimeRange: post: description: Returns the snapshots in the time range specified. tags: - RestoreTasks summary: List Restore Points in a give time range operationId: GetRestorePointsForTimeRange responses: '201': $ref: '#/components/responses/GetRestorePointsForTimeRangeResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/RestorePointsForTimeRangeParam' required: true /public/restore/recover: put: description: 'Updates an existing restore task with additional params which are needed for features like Hot-Standby.' tags: - RestoreTasks operationId: UpdateRestoreTask responses: '200': $ref: '#/components/responses/UpdateRestoreTaskResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRestoreTaskParams' required: true summary: Update restore task x-summary-source: derived post: description: 'Returns the created Restore Task. This operation returns the following types of Restore Tasks: 1) A Restore Task that recovers VMs back to the original location or a new location. 2) A Restore Task that mounts the volumes of a Server (such as a VM or Physical Server) onto the specified target system. The Snapshots of the Server that contains the volumes that are mounted is determined by Array of Objects. The content of the Server is available from the mount point for the Granular Level Recovery (GLR) of application data. For example recovering Microsoft Exchange data using Kroll Ontrack® PowerControls™. NOTE: Volumes are mounted "instantly" if the Snapshot is stored locally on the Cohesity Cluster. If the Snapshot is archival target, it will take longer because it must be retrieved.' tags: - RestoreTasks summary: Create a Restore Task for recovering VMs or instantly mounting volumes operationId: CreateRecoverTask responses: '201': $ref: '#/components/responses/CreateRecoverTaskResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/RecoverTaskRequest' description: 'Request to create a Restore Task for recovering VMs or mounting volumes to mount points.' required: true /public/restore/tasks: get: description: 'If no parameters are specified, all Restore Tasks found on the Cohesity Cluster are returned. Both running and completed Restore Tasks are reported. Specifying parameters filters the results that are returned.' tags: - RestoreTasks summary: List the Restore Tasks filtered by the specified parameters operationId: GetRestoreTasks parameters: - x-go-name: TaskIds description: Filter by a list of Restore Task ids. name: taskIds in: query schema: type: array items: type: integer format: int64 - x-go-name: StartTimeUsecs description: 'Filter by a start time specified as a Unix epoch Timestamp (in microseconds). All Restore Tasks (both completed and running) on the Cohesity Cluster that started after the specified start time but before the specified end time are returned. If not set, the start time is creation time of the Cohesity Cluster.' name: startTimeUsecs in: query schema: type: integer format: int64 - x-go-name: EndTimeUsecs description: 'Filter by an end time specified as a Unix epoch Timestamp (in microseconds). All Restore Tasks (both completed and running) on the Cohesity Cluster that started after the specified start time but before the specified end time are returned. If not set, the end time is the current time.' name: endTimeUsecs in: query schema: type: integer format: int64 - x-go-name: PageCount description: 'Specifies the number of completed Restore Tasks to return in the response for pagination purposes. Running Restore Tasks are always returned. The newest completed Restore Tasks are returned.' name: pageCount in: query schema: type: integer format: int64 - x-go-name: TaskTypes description: 'Filter by the types of Restore Tasks such as ''kRecoverVMs'', ''kCloneVMs'', ''kCloneView'' or ''kMountVolumes''.' name: taskTypes in: query schema: type: array items: type: string - x-go-name: Environment description: 'Specifies the environment like VMware, SQL, where the Protection Source exists. 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.' name: environment in: query schema: type: string 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 responses: '200': $ref: '#/components/responses/GetRestoreTasksResponse' default: $ref: '#/components/responses/Error' /public/restore/tasks/cancel/{id}: put: tags: - RestoreTasks summary: Cancel a recover or clone task with specified id operationId: CancelRestoreTask parameters: - x-go-name: Id description: Specifies a unique id for the Restore Task. name: id in: path required: true schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/SuccessResponse' default: $ref: '#/components/responses/Error' /public/restore/tasks/{id}: get: description: Returns the Restore Task corresponding to the specified Restore Task id. tags: - RestoreTasks summary: List details about a single Restore Task operationId: GetRestoreTaskById parameters: - x-go-name: Id description: Specifies a unique id for the Restore Task. name: id in: path required: true schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/GetRestoreTaskByIdResponse' default: $ref: '#/components/responses/Error' /public/restore/virtualDiskInformation: get: tags: - RestoreTasks summary: Fetches information of virtual disk operationId: GetVirtualDiskInformation parameters: - x-go-name: ClusterId description: Specifies the Cohesity Cluster id where the Job was created. name: clusterId in: query required: true schema: type: integer format: int64 - x-go-name: ClusterIncarnationId description: 'Specifies the incarnation id of the Cohesity Cluster where the Job was created.' name: clusterIncarnationId in: query required: true schema: type: integer format: int64 - x-go-name: JobId description: Specifies the id of the Job that captured the snapshot. name: jobId in: query required: true schema: type: integer format: int64 - x-go-name: JobRunId description: Specifies the id of the Job Run that captured the snapshot. name: jobRunId in: query required: true schema: type: integer format: int64 - x-go-name: StartTimeUsecs description: 'Specifies the start time of the job run as a Unix epoch Timestamp in microseconds.' name: startTimeUsecs in: query required: true schema: type: integer format: int64 - x-go-name: SourceId description: Specifies the Id of the Protection Source object. name: sourceId in: query required: true schema: type: integer format: int64 - x-go-name: VaultId description: Specifies the Id of the vault where snapshot was taken. name: vaultId in: query schema: type: integer format: int64 - x-go-name: VaultName description: Specifies the name of the vault where snapshot was taken. name: vaultName in: query schema: type: string - x-go-name: VaultType description: Specifes the type of the vault where snapshot was taken. name: vaultType in: query schema: type: string enum: - kCloud - kTape - kNas responses: '200': $ref: '#/components/responses/GetVirtualDiskInformationResponse' default: $ref: '#/components/responses/Error' /public/restore/vms/directoryList: get: tags: - RestoreTasks summary: Get the directory list based on the given directory name and other query… operationId: GetVmDirectoryList parameters: - x-go-name: JobId description: 'JobId is the id of the local job that took the snapshot, which may or may not match the JobUidObjectId below depending on whether the object originally belonged to this local job or to a different remote job.' name: jobId in: query required: true schema: type: integer format: int64 - x-go-name: JobUidObjectId description: 'JobUidObjectId is 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 JobId of the remote job, else it will contain the JobId of the local job.' name: jobUidObjectId in: query required: true schema: type: integer format: int64 - x-go-name: EntityId description: EntityId is the Id of the VM. name: entityId in: query required: true schema: type: integer format: int64 - x-go-name: JobInstanceId description: JobInstanceId is the Id of the job run that backed up the entity. name: jobInstanceId in: query required: true schema: type: integer format: int64 - x-go-name: JobStartTimeUsecs description: 'JobStartTimeUsecs is the start time in usecs of the job run that backed up the entity.' name: jobStartTimeUsecs in: query required: true schema: type: integer format: int64 - x-go-name: AttemptNum description: 'AttemptNum is the attempt number of the run that successfully created the snapshot.' name: attemptNum in: query schema: type: integer format: int64 - x-go-name: VolumeName description: 'VolumeName is the name of the volume that needs to be browsed. This should match the name returned in VolumeInfo.' name: volumeName in: query schema: type: string - x-go-name: ViewBoxId description: Id of the View Box if a View is being browsed. name: viewBoxId in: query schema: type: integer format: int64 - x-go-name: ViewName description: Name of the View if a View is being browsed. name: viewName in: query schema: type: string - x-go-name: DirPath description: DirPath is the full path of the directory whose contents need to be listed. name: dirPath in: query required: true schema: type: string - x-go-name: MaxEntries description: 'MaxEntries is the maximum number of entries to return in this call. If there are more entries, server will return a cookie in the response that can be used to continue enumeration from the last call.' name: maxEntries in: query schema: type: integer format: int32 - x-go-name: VolumeInfoCookie description: 'VolumeInfoCookie is the cookie to be passed in calls to reading a VM dir for this volume.' name: volumeInfoCookie in: query schema: type: integer format: uint64 - x-go-name: Cookie description: 'Cookie is used for paginating results. If ReadDirResult returned partial results, it will also return a cookie that can be used to resume the listing. The value returned in ReadDirResult should be passed in the next call. The first call should not have this value set. Note that this value is only a suggestion and server is free to do a short read (return fewer entries along with a cookie).' name: cookie in: query schema: type: string - x-go-name: StatFileEntries description: StatFileEntries specifies whether file stat data is returned. name: statFileEntries in: query schema: type: boolean - x-go-name: BrowseIndexedData description: Specifies whether to use indexed data in Librarian for browse. name: browseIndexedData in: query schema: type: boolean responses: '200': $ref: '#/components/responses/GetVmDirectoryListResponse' default: $ref: '#/components/responses/Error' /public/restore/vms/volumesInformation: get: description: 'All required fields must be specified for this operation. To get values for these fields, invoke the GET /public/restore/objects operation. A specific Job Run is defined by the jobRunId, startedTimeUsecs, and attemptNumber fields.' tags: - RestoreTasks summary: Get information about the logical volumes found in a VM operationId: GetVmVolumesInformation parameters: - x-go-name: JobId description: 'Specifies the Job id for the Protection Job that is currently associated with the object. If the object was backed up on current Cohesity Cluster, this field contains the id for the Job that captured this backup object. If the object was backed up on a Primary Cluster and replicated to this Cohesity Cluster, a new Inactive Job is created, the object is now associated with new Inactive Job, and this field contains the id of the new Inactive Job.' name: jobId in: query required: true schema: type: integer format: int64 - x-go-name: ClusterId description: Specifies the Cohesity Cluster id where the Job was created. name: clusterId in: query required: true schema: type: integer format: int64 - x-go-name: ClusterIncarnationId description: 'Specifies the incarnation id of the Cohesity Cluster where the Job was created. An incarnation id is generated when a Cohesity Cluster is initially created.' name: clusterIncarnationId in: query required: true schema: type: integer format: int64 - x-go-name: JobRunId description: Specifies the id of the Job Run that captured the snapshot. name: jobRunId in: query required: true schema: type: integer format: int64 - x-go-name: StartedTimeUsecs description: 'Specifies the time when the Job Run starts capturing a snapshot. Specified as a Unix epoch Timestamp (in microseconds).' name: startedTimeUsecs in: query required: true schema: type: integer format: int64 - x-go-name: AttemptNumber description: 'Specifies the number of the attempts made by the Job Run to capture a snapshot of the object. For example, if an snapshot is successfully captured after three attempts, this field equals 3.' name: attemptNumber in: query schema: type: integer format: int64 - x-go-name: SourceId description: Specifies the id of the VM object to search for volumes. name: sourceId in: query required: true schema: type: integer format: int64 - x-go-name: OriginalJobId description: 'Specifies the id for the Protection Job that originally captured the snapshots of the original object. If the object was backed up on a Primary Cluster replicated to this Cohesity Cluster, and a new Inactive Job is created, this field still contains the id of the original Job and NOT the id of the new Inactive Job. This field is used in combination with the clusterId and clusterIncarnationId to uniquely identify a Job.' name: originalJobId in: query required: true schema: type: integer format: int64 - x-go-name: SupportedVolumesOnly description: 'Specifies to return only supported volumes information. Unsupported volumes are not returned if this flag is set to true. Default is false.' name: supportedVolumesOnly in: query schema: type: boolean - x-go-name: ComputeVolumeInfo description: 'Specifies whether to compute volume information if it is not found. If `ComputeVolumeInfo` is false and volume information is not found it skips computation of volume information and returns KNotFound.' name: computeVolumeInfo in: query schema: type: boolean responses: '200': $ref: '#/components/responses/GetVmVolumesInformationResponse' default: $ref: '#/components/responses/Error' /public/virtualDatacenters/{id}/storageProfiles: get: tags: - RestoreTasks summary: Fetches information of virtual disk operationId: ListStorageProfiles parameters: - x-go-name: Id description: Specifies a unique id for the VDC. name: id in: path required: true schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/ListStorageProfilesResponse' default: $ref: '#/components/responses/Error' 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 AzureProtectionSource: description: Specifies a Protection Source in Azure environment. type: object title: Azure Protection Source. properties: applicationId: description: Specifies Application Id of the active directory of Azure account. type: - string - 'null' x-go-name: ApplicationId applicationKey: description: Specifies Application key of the active directory of Azure account. type: - string - 'null' x-go-name: ApplicationKey azureType: description: 'Specifies the entity type such as ''kSubscription'' if the environment is kAzure. Specifies the type of an Azure source entity. ''kSubscription'' indicates a billing unit within Azure account. ''kResourceGroup'' indicates a container that holds related resources. ''kVirtualMachine'' indicates a Virtual Machine in Azure environment. ''kStorageAccount'' represents a collection of storage containers. ''kStorageKey'' indicates a key required to access the storage account. ''kStorageContainer'' represents a storage container within a storage account. ''kStorageBlob'' represents a storage blog within a storage container. ''kStorageResourceGroup'' indicates a container that holds related storage resources. ''kNetworkSecurityGroup'' represents a network security group. ''kVirtualNetwork'' represents a virtual network. ''kNetworkResourceGroup'' indicates a container that holds related network resources. ''kSubnet'' represents a subnet within the virtual network. ''kComputeOptions'' indicates the number of CPU cores and memory size available for a type of a Virtual Machine.' type: - string - 'null' enum: - kSubscription - kResourceGroup - kVirtualMachine - kStorageAccount - kStorageKey - kStorageContainer - kStorageBlob - kStorageResourceGroup - kNetworkSecurityGroup - kVirtualNetwork - kNetworkResourceGroup - kSubnet - kComputeOptions x-go-name: AzureType hostType: description: 'Specifies the OS type of the Protection Source of type ''kVirtualMachine'' such as ''kWindows'' or ''kLinux''. overrideDescription: true ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: HostType ipAddresses: description: Specifies a list of IP addresses for entities of type 'kVirtualMachine'. type: - array - 'null' items: type: string x-go-name: IpAddresses isManagedVm: description: 'Specifies whether VM is managed or not for entities of type ''kVirtualMachine''.' type: - boolean - 'null' x-go-name: IsManagedVm location: description: Specifies the physical location of the resource group. type: - string - 'null' x-go-name: Location memoryMbytes: description: 'Specifies the amount of memory in MegaBytes of the Azure resource of type ''kComputeOptions''.' type: - integer - 'null' format: int64 x-go-name: MemoryMbytes name: description: 'Specifies the name of the Object set by the Cloud Provider. If the provider did not set a name for the object, this field is not set.' type: - string - 'null' x-go-name: Name numCores: description: 'Specifies the number of CPU cores of the Azure resource of type ''kComputeOptions''.' type: - integer - 'null' format: int32 x-go-name: NumCores physicalSourceId: description: 'Specifies the Protection Source id of the registered Physical Host. If the cloud entity is protected using a Physical Agent, it must be registered as a physical host.' type: - integer - 'null' format: int64 x-go-name: PhysicalSourceId resourceId: description: Specifies the unique Id of the resource given by the cloud provider. type: - string - 'null' x-go-name: ResourceId restoreTaskId: description: 'Specifies the id of the "convert and deploy" restore task that created the entity in the cloud. It is required to support the DR-to-cloud usecase where we replicate an on-prem entity to a cluster running in cloud, bring it up using "convert and deploy" mechanism, protect it using a cloud job that uses physical adapter, and convert it back to the on-prem format before replication. Before replicating, we need to update the backup task state of the backed up entity using the on-prem entity and on-prem entity''s parent. The id is used to lookup the restore entity that contains details about the on-prem entity. It is set at the time of refreshing the cloud entity hierarchy if all the following conditions are met: Name of the current entity matches with name of any cloud entity deployed using the "convert and deploy" restore task. Restore entity associated with the above matched cloud entity has ''failed_over'' flag set to true in its cloud extension.' type: - integer - 'null' format: int64 x-go-name: RestoreTaskId subscriptionId: description: 'Specifies Subscription id inside a customer''s Azure account. It represents sub-section within the Azure account where a customer allows us to create VMs, storage account etc.' type: - string - 'null' x-go-name: SubscriptionId subscriptionType: description: 'Specifies the subscription type of Azure such as ''kAzureCommercial'' or ''kAzureGovCloud''. Specifies the subscription type of an Azure source entity. ''kAzureCommercial'' indicates a standard Azure subscription. ''kAzureGovCloud'' indicates a govt Azure subscription.' type: - string - 'null' enum: - kAzureCommercial - kAzureGovCloud x-go-name: SubscriptionType tenantId: description: Specifies Tenant Id of the active directory of Azure account. type: - string - 'null' x-go-name: TenantId type: description: 'Specifies the type of an Azure Protection Source Object such as ''kStorageContainer'', ''kVirtualMachine'', ''kVirtualNetwork'', etc. Specifies the type of an Azure source entity. ''kSubscription'' indicates a billing unit within Azure account. ''kResourceGroup'' indicates a container that holds related resources. ''kVirtualMachine'' indicates a Virtual Machine in Azure environment. ''kStorageAccount'' represents a collection of storage containers. ''kStorageKey'' indicates a key required to access the storage account. ''kStorageContainer'' represents a storage container within a storage account. ''kStorageBlob'' represents a storage blog within a storage container. ''kStorageResourceGroup'' indicates a container that holds related storage resources. ''kNetworkSecurityGroup'' represents a network security group. ''kVirtualNetwork'' represents a virtual network. ''kNetworkResourceGroup'' indicates a container that holds related network resources. ''kSubnet'' represents a subnet within the virtual network. ''kComputeOptions'' indicates the number of CPU cores and memory size available for a type of a Virtual Machine.' type: - string - 'null' enum: - kSubscription - kResourceGroup - kVirtualMachine - kStorageAccount - kStorageKey - kStorageContainer - kStorageBlob - kStorageResourceGroup - kNetworkSecurityGroup - kVirtualNetwork - kNetworkResourceGroup - kSubnet - kComputeOptions x-go-name: Type x-go-package: cohesity/iris/server/data/public PhysicalProtectionSource: description: Specifies a Protection Source in a Physical environment. type: object title: Physical Protection Source. properties: agents: description: 'Array of Agents on the Physical Protection Source. Specifiles the agents running on the Physical Protection Source and the status information.' type: - array - 'null' items: $ref: '#/components/schemas/AgentInformation' x-go-name: Agents hostName: description: Specifies the hostname. type: - string - 'null' x-go-name: HostName hostType: description: 'Specifies the environment type for the host. ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: HostType id: description: 'Specifies a unique id of a Physical Protection Source. The id is unique across Cohesity Clusters.' allOf: - $ref: '#/components/schemas/UniversalId' memorySizeBytes: description: Specifies the total memory on the host in bytes. type: - integer - 'null' format: int64 x-go-name: MemorySizeBytes name: description: Specifies a human readable name of the Protection Source. type: - string - 'null' x-go-name: Name networkingInfo: description: 'Cached networking info. This establishes physical-->agent linkage for the Cluster case.' $ref: '#/components/schemas/NetworkingInformation' numProcessors: description: Specifies the number of processors on the host. type: - integer - 'null' format: int64 x-go-name: NumProcessors osName: description: Specifies a human readable name of the OS of the Protection Source. type: - string - 'null' x-go-name: OsName type: description: 'Specifies the type of managed Object in a Physical Protection Source. ''kGroup'' indicates the EH container. ''kHost'' indicates a single physical server. ''kWindowsCluster'' indicates a Microsoft Windows cluster. ''kOracleRACCluster'' indicates an Oracle Real Application Cluster(RAC). ''kOracleAPCluster'' indicates an Oracle Active-Passive Cluster.' type: - string - 'null' enum: - kGroup - kHost - kWindowsCluster - kOracleRACCluster - kOracleAPCluster x-go-name: Type vcsVersion: description: Specifies cluster version for VCS host. type: - string - 'null' x-go-name: VcsVersion volumes: description: 'Array of Physical Volumes. Specifies the volumes available on the physical host. These fields are populated only for the kPhysicalHost type.' type: - array - 'null' items: $ref: '#/components/schemas/PhysicalVolume' x-go-name: Volumes x-go-package: cohesity/iris/server/data/public FilenamePatternToDirectory: description: 'Specifies a filename pattern and the directory path where to keep files matching that pattern.' type: object title: Filename Pattern to Directory. properties: directory: description: Specifies the directory where to keep the files matching the pattern. type: - string - 'null' x-go-name: Directory filenamePattern: description: 'Specifies a pattern to be matched with filenames. This can be a regex expression.' type: - string - 'null' x-go-name: FilenamePattern x-go-package: cohesity/iris/server/data/public FullSnapshotInfo: description: 'Specifies the info regarding how to restore to a particular full or incremental snapshot.' type: object properties: restoreInfo: description: Specifies the full or incremental snapshot. $ref: '#/components/schemas/RestoreInfo' snapshotTarget: description: 'Specifies the location holding snapshot copies that may be used for restore.' type: - array - 'null' items: $ref: '#/components/schemas/SnapshotTargetSettings' x-go-name: SnapshotTarget x-go-package: cohesity/iris/server/data/public 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 OneDriveItem: description: Specifies the details about OneDrive file/folder. type: object title: OneDrive Item. properties: isFileItem: description: Specifies whether the current item is a file or not. type: - boolean - 'null' x-go-name: IsFileItem itemId: description: Specifies the Id of the Drive item. type: - string - 'null' x-go-name: ItemId itemPath: description: Specifies the path of the Drive item within the drive. type: - string - 'null' x-go-name: ItemPath x-go-package: cohesity/iris/server/data/public CouchbaseCluster: description: Specifies an Object containing information about a couchbase cluster. type: object title: Couchbase Cluster Info. properties: seeds: description: Seeds of this Couchbase Cluster. type: - array - 'null' items: type: string x-go-name: Seeds x-go-package: cohesity/iris/server/data/public PublicFoldersRestoreParameters: description: 'Specifies information needed for recovering O365 Public Folders in O365Publicfolders environment.' type: object title: O365 Public Folders Restore Parameters. properties: rootPublicFolderList: description: Specifies the list of Public Folders to be restored. type: - array - 'null' items: $ref: '#/components/schemas/RootPublicFolder' x-go-name: RootPublicFolderList targetFolderPath: description: Specifies the target folder path to restore the Public Folders. type: - string - 'null' x-go-name: TargetFolderPath targetRootPublicFolder: description: 'Specifies the destination Public Folder where the Public Folders specified within RootPublicFolders will be restored with their appropriate paths.' $ref: '#/components/schemas/ProtectionSource' x-go-package: cohesity/iris/server/data/public TagAttribute: description: Specifies a VMware tag. type: object title: VMware Tag Attributes. properties: gcpTagType: description: 'Specifies the tag attribute type of GCP. Going forward, there will be an additional TagTypes for AWS as well. Specifies the type of the tag GCP entity refers to. ''kNetworkTag'' indicates a network tag present on instances. ''kLabel'' indicates a label (key-value pair) present on instances. ''kCustomMetadata'' indicates custom Metadata (key-value pair) present on instances.' type: - string - 'null' enum: - kNetworkTag - kLabel - kCustomMetadata x-go-name: GcpTagType id: description: Specifies the Coheisty id of the VM tag. type: - integer - 'null' format: int64 x-go-name: Id name: description: Specifies the VMware name of the VM tag. type: - string - 'null' x-go-name: Name uuid: description: 'Specifies the VMware Universally Unique Identifier (UUID) of the VM tag.' type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public 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 ThrottlingPolicyParameters: description: Specifies the throttling policy for a registered Protection Source. type: object title: Throttling Policy. properties: enforceMaxStreams: description: 'Specifies whether datastore streams are configured for all datastores that are part of the registered entity. If set to true, number of streams from Cohesity cluster to the registered entity will be limited to the value set for maxConcurrentStreams. If not set or set to false, there is no max limit for the number of concurrent streams.' type: - boolean - 'null' x-go-name: EnforceMaxStreams enforceRegisteredSourceMaxBackups: description: 'Specifies whether no. of backups are configured for the registered entity. If set to true, number of backups made by Cohesity cluster in the registered entity will be limited to the value set for RegisteredSourceMaxConcurrentBackups. If not set or set to false, there is no max limit for the number of concurrent backups.' type: - boolean - 'null' x-go-name: EnforceRegisteredSourceMaxBackups isEnabled: description: 'Indicates whether read operations to the datastores, which are part of the registered Protection Source, are throttled.' type: - boolean - 'null' x-go-name: IsEnabled latencyThresholds: description: 'Specifies the thresholds that should be applied to all datastores that are part of the registered Object.' $ref: '#/components/schemas/LatencyThresholds' maxConcurrentStreams: description: 'Specifies the limit on the number of streams Cohesity cluster will make concurrently to the datastores of the registered entity. This limit is enforced only when the flag enforceMaxStreams is set to true.' type: - integer - 'null' format: int32 x-go-name: MaxConcurrentStreams registeredSourceMaxConcurrentBackups: description: 'Specifies the limit on the number of backups Cohesity cluster will make concurrently to the registered entity. This limit is enforced only when the flag enforceRegisteredSourceMaxBackups is set to true.' type: - integer - 'null' format: int32 x-go-name: RegisteredSourceMaxConcurrentBackups x-go-package: cohesity/iris/server/data/public AcropolisProtectionSource: description: Specifies a Protection Source in Acropolis environment. type: object title: Acropolis Protection Source. properties: clusterUuid: description: 'Specifies the UUID of the Acropolis cluster instance to which this entity belongs to.' type: - string - 'null' x-go-name: ClusterUuid description: description: Specifies a description about the Protection Source. type: - string - 'null' x-go-name: Description mountPath: description: 'Specifies whether the VM is an agent VM. This is applicable to acropolis entity of type kVirtualMachine.' type: - boolean - 'null' x-go-name: IsAgentVm name: description: Specifies the name of the Acropolis Object. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of an Acropolis Protection Source Object such as ''kPrismCentral'', ''kHost'', ''kNetwork'', etc. Specifies the type of an Acropolis source entity. ''kPrismCentral'' indicates a collection of multiple Nutanix clusters. ''kStandaloneCluster'' indicates a single Nutanix cluster. ''kCluster'' indicates a Nutanix cluster managed by a Prism Central. ''kHost'' indicates an Acropolis host. ''kVirtualMachine'' indicates a Virtual Machine. ''kNetwork'' indicates a Virtual Machine network object. ''kStorageContainer'' represents a storage container object.' type: - string - 'null' enum: - kPrismCentral - kStandaloneCluster - kCluster - kHost - kVirtualMachine - kNetwork - kStorageContainer x-go-name: Type uuid: description: 'Specifies the UUID of the Acropolis Object. This is unique within the cluster instance. Together with clusterUuid, this entity is unique within the Acropolis environment.' type: - string - 'null' x-go-name: Uuid version: description: Specifies the version of an Acropolis cluster or standalone cluster. type: - string - 'null' x-go-name: Version x-go-package: cohesity/iris/server/data/public FlashBladeFileSystem: description: Specifies information about a Flash Blade File System in a Storage Array. type: object title: Flash Blade File System. properties: backupEnabled: description: 'Specifies whether the .snapshot directory exists on the file system. Backup is enabled only if the directory exists.' type: - boolean - 'null' x-go-name: BackupEnabled createdTimeMsecs: description: 'Specifies the time when the filesystem was created in Unix epoch time in milliseconds.' type: - integer - 'null' format: int64 x-go-name: CreatedTimeMsecs logicalCapacityBytes: description: Specifies the total capacity in bytes of the file system. type: - integer - 'null' format: int64 x-go-name: LogicalCapacityBytes logicalUsedBytes: description: 'Specifies the size of logical data currently represented on the file system in bytes.' type: - integer - 'null' format: int64 x-go-name: LogicalUsedBytes nfsInfo: description: 'Specifies information about an NFS export. This field is set if the file system supports protocol type ''kNfs''.' $ref: '#/components/schemas/FlashBladeNfsInfo' physicalUsedBytes: description: 'Specifies the size of physical data currently consumed by the file system. This includes the space used for the snapshots.' type: - integer - 'null' format: int64 x-go-name: PhysicalUsedBytes protocols: description: 'List of Protocols. Specifies the list of protocols enabled on the file system. ''kNfs'' indicates NFS exports are supported on Pure FlashBlade File System. ''kCifs2'' indicates CIFS/SMB Shares are supported on Pure FlashBlade File System. ''kHttp'' indicates object protocol over HTTP and HTTPS are supported.' type: - array - 'null' items: type: string enum: - kNfs - kCifs2 - kHttp x-go-name: Protocols uniqueUsedBytes: description: 'Specifies the size of physical data consumed by the file system itself not including the size of the snapshots.' type: - integer - 'null' format: int64 x-go-name: UniqueUsedBytes x-go-package: cohesity/iris/server/data/public ConnectorParameters: description: 'Specifies the parameters required to establish a connection with a particular environment.' type: object title: Connector Parameters. properties: endpoint: description: 'Specify an IP address or URL of the environment. (such as the IP address of the vCenter Server for a VMware environment).' type: - string - 'null' x-go-name: Endpoint environment: description: 'Specifies the environment like VMware, SQL, where the Protection Source exists. 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 id: description: 'Specifies a Unique id that is generated when the Source is registered. This is a convenience field that is used to maintain an index to different connection params.' type: - integer - 'null' format: int64 x-go-name: Id version: description: 'Version is updated each time the connector parameters are updated. This is used to discard older connector parameters.' type: - integer - 'null' format: int64 x-go-name: Version x-go-package: cohesity/iris/server/data/public DagApplicationServerInfo: description: 'Specifies the information about the status of the Exchange Application Server which is a member of the DAG.' type: object title: Exchange DAG Application Server Information properties: fqdn: description: Specifies the fully qualified domain name of the Exchange Server. type: - string - 'null' x-go-name: Fqdn guid: description: Specifies the Guid of the Exchange Application Server. type: - string - 'null' x-go-name: Guid id: description: Specifies the entity id of the Exchange Application server. type: - integer - 'null' format: int64 x-go-name: Id name: description: Specifies the display name of the Exchange Application Server. type: - string - 'null' x-go-name: Name ownerId: description: 'Specifies the entity id of the owner entity of the Exchange Application Server.' type: - integer - 'null' format: int64 x-go-name: OwnerId status: description: 'Specifies the status of the registration of the Exchange Application Server. Specifies the status of registration of Exchange Application Server. ''kUnknown'' indicates the status is not known. ''kHealthy'' indicates the status is healty and is registered as Exchange Server. ''kUnHealthy'' indicates the exchange application is registered on the physical server but it is unreachable now. ''kUnregistered'' indicates the server is not registered as physical source. ''kUnreachable'' indicates the server is not reachable from the cohesity cluster or the cohesity protection server is not installed on the exchange server. ''kDetached'' indicates the server is removed from the ExchangeDAG.' type: - string - 'null' enum: - kUnknown - kHealthy - kUnHealthy - kUnregistered - kUreachable - kDetached x-go-name: Status totalSizeBytes: description: 'Specifies the total size of all Exchange database copies in all the Exchange Application Servers that are part of the DAG.' type: - integer - 'null' format: int64 x-go-name: TotalSizeBytes x-go-package: cohesity/iris/server/data/public VirtualDiskInfo: type: object title: Virtual Disk Information. properties: busNumber: description: Specifies the Id of the controller bus that controls the disk. type: - integer - 'null' format: int64 x-go-name: BusNumber controllerType: description: Specifies the controller type like SCSI, or IDE etc. type: - string - 'null' x-go-name: ControllerType filename: description: Specifies the host file name used as the virtual disk. type: - string - 'null' x-go-name: Filename unitNumber: description: 'Specifies the disk file name. This is the VMDK name and not the flat file name.' type: - integer - 'null' format: int64 x-go-name: UnitNumber x-go-package: cohesity/iris/server/data/public SqlSourceId: description: Specifies a unique id for a SQL Protection Source. type: object title: SQL Source Id. properties: createdDateMsecs: description: 'Specifies a unique identifier generated from the date the database is created or renamed. Cohesity uses this identifier in combination with the databaseId to uniquely identify a database.' type: - integer - 'null' format: int64 x-go-name: CreatedDateMsecs databaseId: description: 'Specifies a unique id of the database but only for the life of the database. SQL Server may reuse database ids. Cohesity uses the createDateMsecs in combination with this databaseId to uniquely identify a database.' type: - integer - 'null' format: int64 x-go-name: DatabaseId instanceId: description: 'Array of bytes that stores the SQL Server Instance id. Specifies unique id for the SQL Server instance. This id does not change during the life of the instance.' type: - array - 'null' items: type: integer format: uint8 x-go-name: InstanceId x-go-package: cohesity/iris/server/data/public AwsProtectionSource: description: Specifies a Protection Source in AWS environment. type: object title: AWS Protection Source. properties: accessKey: description: Specifies Access key of the AWS account. type: - string - 'null' x-go-name: AccessKey amazonResourceName: description: 'Specifies Amazon Resource Name (owner ID) of the IAM user, act as an unique identifier of as AWS entity.' type: - string - 'null' x-go-name: AmazonResourceName authMethod: description: 'Specifies the authentication method to be used for API calls. Specifies the authentication method to be used for API calls. ''kUseIAMUser'' indicates a user based authentication. ''kUseIAMRole'' indicates a role based authentication, used only for AWS CE.' type: - string - 'null' enum: - kUseIAMUser - kUseIAMRole x-go-name: AuthMethod awsFleetParams: description: 'Specifies information related to AWS fleets launched for various purposes. This will only be set for kIAMUser entity.' $ref: '#/components/schemas/AwsFleetParams' awsType: description: 'Specifies the entity type such as ''kIAMUser'' if the environment is kAWS. Specifies the type of an AWS source entity. ''kIAMUser'' indicates a unique user within an AWS account. ''kRegion'' indicates a geographical region in the global infrastructure. ''kAvailabilityZone'' indicates an availability zone within a region. ''kEC2Instance'' indicates a Virtual Machine running in AWS environment. ''kVPC'' indicates a virtual private cloud (VPC) network within AWS. ''kSubnet'' indicates a subnet inside the VPC. ''kNetworkSecurityGroup'' represents a network security group. ''kInstanceType'' represents various machine types. ''kKeyPair'' represents a pair of public and private key used to login into a Virtual Machine. ''kTag'' represents a tag attached to EC2 instance. ''kRDSOptionGroup'' represents a RDS option group for configuring database features. ''kRDSParameterGroup'' represents a RDS parameter group. ''kRDSInstance'' represents a RDS DB instance. ''kRDSSubnet'' represents a RDS subnet. ''kRDSTag'' represents a tag attached to RDS instance.' type: - string - 'null' enum: - kIAMUser - kRegion - kAvailabilityZone - kEC2Instance - kVPC - kSubnet - kNetworkSecurityGroup - kInstanceType - kKeyPair - kTag - kRDSOptionGroup - kRDSParameterGroup - kRDSInstance - kRDSSubnet - kRDSTag x-go-name: AwsType clusterNetworkInfo: description: 'Specifies information related to cluster. This is only valid for CE clusters. This is only populated for kIAMUser entity.' $ref: '#/components/schemas/FleetNetworkParams' dbEngineId: description: 'Specifies DB engine version info of the entity. This is populated only for RDSInstance, RDSOptionGroup and RDSParameterGroup entity types.' type: - string - 'null' x-go-name: DbEngineId hostType: description: 'Specifies the OS type of the Protection Source of type ''kVirtualMachine'' such as ''kWindows'' or ''kLinux''. overrideDescription: true ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: HostType iamRoleArn: description: 'Specifies the IAM role which will be used to access the security credentials required for API calls.' type: - string - 'null' x-go-name: IamRoleArn ipAddresses: description: Specifies the IP address of the entity of type 'kVirtualMachine'. type: - string - 'null' x-go-name: IpAddress name: description: 'Specifies the name of the Object set by the Cloud Provider. If the provider did not set a name for the object, this field is not set.' type: - string - 'null' x-go-name: Name ownerId: description: 'Specifies the owner id of the resource in AWS environment. With type, name and ownerId gives a globally unique identity to the AWS entity.' type: - string - 'null' x-go-name: OwnerId physicalSourceId: description: 'Specifies the Protection Source id of the registered Physical Host. If the cloud entity is protected using a Physical Agent, it must be registered as a physical host.' type: - integer - 'null' format: int64 x-go-name: PhysicalSourceId regionId: description: Specifies the region Id of the entity if the entity is an EC2 instance. type: - string - 'null' x-go-name: RegionId resourceId: description: Specifies the unique Id of the resource given by the cloud provider. type: - string - 'null' x-go-name: ResourceId restoreTaskId: description: 'Specifies the id of the "convert and deploy" restore task that created the entity in the cloud. It is required to support the DR-to-cloud usecase where we replicate an on-prem entity to a cluster running in cloud, bring it up using "convert and deploy" mechanism, protect it using a cloud job that uses physical adapter, and convert it back to the on-prem format before replication. Before replicating, we need to update the backup task state of the backed up entity using the on-prem entity and on-prem entity''s parent. The id is used to lookup the restore entity that contains details about the on-prem entity. It is set at the time of refreshing the cloud entity hierarchy if all the following conditions are met: Name of the current entity matches with name of any cloud entity deployed using the "convert and deploy" restore task. Restore entity associated with the above matched cloud entity has ''failed_over'' flag set to true in its cloud extension.' type: - integer - 'null' format: int64 x-go-name: RestoreTaskId secretAccessKey: description: Specifies Secret Access key of the AWS account. type: - string - 'null' x-go-name: SecretAccessKey subscriptionType: description: 'Specifies the subscription type of AWS such as ''kAWSCommercial'' or ''kAWSGovCloud''. Specifies the subscription type of an AWS source entity. ''kAWSCommercial'' indicates a standard AWS subscription. ''kAWSGovCloud'' indicates a govt AWS subscription.' type: - string - 'null' enum: - kAWSCommercial - kAWSGovCloud x-go-name: SubscriptionType tagAttributes: description: Specifies the list of AWS tag attributes. type: - array - 'null' items: $ref: '#/components/schemas/TagAttribute' x-go-name: TagAttributes type: description: 'Specifies the type of an AWS Protection Source Object such as ''kStorageContainer'', ''kVirtualMachine'', ''kVirtualNetwork'', etc. Specifies the type of an AWS source entity. ''kIAMUser'' indicates a unique user within an AWS account. ''kRegion'' indicates a geographical region in the global infrastructure. ''kAvailabilityZone'' indicates an availability zone within a region. ''kEC2Instance'' indicates a Virtual Machine running in AWS environment. ''kVPC'' indicates a virtual private cloud (VPC) network within AWS. ''kSubnet'' indicates a subnet inside the VPC. ''kNetworkSecurityGroup'' represents a network security group. ''kInstanceType'' represents various machine types. ''kKeyPair'' represents a pair of public and private key used to login into a Virtual Machine. ''kTag'' represents a tag attached to EC2 instance. ''kRDSOptionGroup'' represents a RDS option group for configuring database features. ''kRDSParameterGroup'' represents a RDS parameter group. ''kRDSInstance'' represents a RDS DB instance. ''kRDSSubnet'' represents a RDS subnet. ''kRDSTag'' represents a tag attached to RDS instance.' type: - string - 'null' enum: - kIAMUser - kRegion - kAvailabilityZone - kEC2Instance - kVPC - kSubnet - kNetworkSecurityGroup - kInstanceType - kKeyPair - kTag - kRDSOptionGroup - kRDSParameterGroup - kRDSInstance - kRDSSubnet - kRDSTag x-go-name: Type userAccountId: description: Specifies the account id derived from the ARN of the user. type: - string - 'null' x-go-name: UserAccountId userResourceName: description: Specifies the Amazon Resource Name (ARN) of the user. type: - string - 'null' x-go-name: UserResourceName x-go-package: cohesity/iris/server/data/public Disk: description: Specifies information about a disk and partitions in a volume. type: object title: Disk in a Volume. properties: diskBlocks: description: 'Array of Disk Blocks. Specifies a set of disk blocks by defining the location and offset of disk blocks in a disk.' type: - array - 'null' items: $ref: '#/components/schemas/DiskBlock' x-go-name: DiskBlocks diskFormat: description: 'Specifies the format of the virtual disk. ''kVMDK'' indicates VMware''s Virtual Disk format. ''kVHD'' indicates Microsoft''s Virtual Hard Drive format. ''kVHDx'' indicates Microsoft''s Hyper-V Virtual Hard Drive format. ''kRaw'' indicates Raw disk format used by KVM, Acropolis. ''kUnknow'' indicates Unknown disk format.' type: - string - 'null' enum: - kVMDK - kVHD - kVHDx - kRaw - kUnknown x-go-name: DiskFormat diskPartitions: description: 'Array of Partitions. Specifies information about all the partitions in this disk.' type: - array - 'null' items: $ref: '#/components/schemas/DiskPartition' x-go-name: DiskPartitions partitionTableFormat: description: 'Specifies partition table format on a disk. ''kNoPartition'' indicates missing partition table. ''kMBRPartition'' indicates partition table is in Master Boot Record format. ''kGPTPartition'' indicates partition table is in Guid Partition Table format. ''kSGIPartition'' indicates partition table uses SGI scheme. ''kSUNPartition'' indicates partition table uses SUN scheme.' type: - string - 'null' enum: - kNoPartition - kMBRPartition - kGPTPartition - kSGIPartition - kSUNPartition x-go-name: PartitionTableFormat sectorSizeBytes: description: 'Specifies the sector size of hard disk. It is used for mapping the disk blocks of the disk file into a linear list of sectors.' type: - integer - 'null' format: int64 x-go-name: SectorSizeBytes uuid: description: Specifies the disk uuid. type: - string - 'null' x-go-name: Uuid vmdkFileName: description: 'Specifies the disk file name. This is the VMDK name and not the flat file name.' type: - string - 'null' x-go-name: VmdkFileName vmdkSizeBytes: description: Specifies the disk size in bytes. type: - integer - 'null' format: int64 x-go-name: VmdkSizeBytes x-go-package: cohesity/iris/server/data/public HostSettingsCheckResult: description: Specifies the result of various checks performed internally on host. type: object title: Host Setting Check Result. properties: checkType: description: 'Specifies the type of the check internally performed. Specifies the type of the host check performed internally. ''kIsAgentPortAccessible'' indicates the check for agent port access. ''kIsAgentRunning'' indicates the status for the Cohesity agent service. ''kIsSQLWriterRunning'' indicates the status for SQLWriter service. ''kAreSQLInstancesRunning'' indicates the run status for all the SQL instances in the host. ''kCheckServiceLoginsConfig'' checks the privileges and sysadmin status of the logins used by the SQL instance services, Cohesity agent service and the SQLWriter service. ''kCheckSQLFCIVIP'' checks whether the SQL FCI is registered with a valid VIP or FQDN. ''kCheckSQLDiskSpace'' checks whether volumes containing SQL DBs have at least 10% free space.' type: - string - 'null' enum: - kIsAgentPortAccessible - kIsAgentRunning - kIsSQLWriterRunning - kAreSQLInstancesRunning - kCheckServiceLoginsConfig - kCheckSQLFCIVIP - kCheckSQLDiskSpace x-go-name: CheckType resultType: description: 'Specifies the type of the result returned after performing the internal host check. Specifies the type of the host check result performed internally. ''kPass'' indicates that the respective check was successful. ''kFail'' indicates that the respective check failed as some mandatory setting is not met ''kWarning'' indicates that the respective check has warning as certain non-mandatory setting is not met.' type: - string - 'null' enum: - kPass - kFail - kWarning x-go-name: ResultType userMessage: description: Specifies a descriptive message for failed/warning types. type: - string - 'null' x-go-name: UserMessage x-go-package: cohesity/iris/server/data/public VmDirEntry: description: VmDirEntry is the struct to represent a file or a folder on a VM. type: object title: VM Directory Entry. properties: fstatInfo: description: FstatInfo is the stat information for the file. $ref: '#/components/schemas/FileStatInfo' fullPath: description: FullPath is the full path of the file/directory. type: - string - 'null' x-go-name: FullPath name: description: 'Name is the name of the file or folder. For /test/file.txt, name will be file.txt.' type: - string - 'null' x-go-name: Name type: description: 'DirEntryType is the type of entry i.e. file/folder. Specifies the type of directory entry. ''kFile'' indicates that current entry is of file type. ''kDirectory'' indicates that current entry is of directory type. ''kSymlink'' indicates that current entry is of symbolic link.' type: - string - 'null' enum: - kFile - kDirectory - kSymlink x-go-name: Type x-go-package: cohesity/iris/server/data/public StoragePolicyOverride: description: 'Specifies if inline deduplication and compression settings inherited from Storage Domain (View Box) should be disabled for this View.' type: object title: Storage Policy Override. properties: disableInlineDedupAndCompression: description: 'If false, the inline deduplication and compression settings inherited from the Storage Domain (View Box) apply to this View. If true, both inline deduplication and compression are disabled for this View. This can only be set to true if inline deduplication is set for the Storage Domain (View Box).' type: - boolean - 'null' x-go-name: DisableInlineDedupAndCompression x-go-package: cohesity/iris/server/data/public KubernetesProtectionSource: description: Specifies a Protection Source in Kubernetes environment. type: object title: Kubernetes Protection Source. properties: description: description: Specifies an optional description of the object. type: - string - 'null' x-go-name: Description name: description: Specifies a unique name of the Protection Source. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of the entity in a Kubernetes environment. Specifies the type of a Kubernetes Protection Source. ''kCluster'' indicates a Kubernetes Cluster. ''kNamespace'' indicates a namespace in a Kubernetes Cluster. ''kService'' indicates a service running on a Kubernetes Cluster.' type: - string - 'null' enum: - kCluster - kNamespace - kService x-go-name: Type uuid: description: Specifies the UUID of the object. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public AdDomain: description: Specifies information about an AD Domain. type: object title: AD Domain. properties: dnsRoot: description: Specifies DNS root. type: - string - 'null' x-go-name: DnsRoot forest: description: Specifies AD forest name. type: - string - 'null' x-go-name: Forest identity: description: Specifies Identity information of the domain. $ref: '#/components/schemas/AdDomainIdentity' netbiosName: description: Specifies AD NetBIOS name. type: - string - 'null' x-go-name: NetbiosName parentDomain: description: Specifies parent domain name. type: - string - 'null' x-go-name: ParentDomain tombstoneDays: description: Specifies tombstone time in days. type: - integer - 'null' format: uint32 x-go-name: TombstoneDays x-go-package: cohesity/iris/server/data/public 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 VolumeSecurityInfo: description: Specifies information about NetApp volume security settings. type: object title: Volume Security Information. properties: groupId: description: Specifies the Unix group ID for this volume. 0 indicates the root id. type: - integer - 'null' format: int32 x-go-name: GroupId permissions: description: Specifies the Unix permission bits in octal string format. type: - string - 'null' x-go-name: Permissions style: description: 'Specifies the security style associated with this volume. Specifies the type of a NetApp Volume. ''kUnix'' indicates Unix-style security. ''kNtfs'' indicates Windows NTFS-style security. ''kMixed'' indicates mixed-style security. ''kUnified'' indicates Unified-style security.' type: - string - 'null' enum: - kUnix - kNtfs - kMixed - kUnified x-go-name: Style userId: description: Specifies the Unix user id for this volume. 0 indicates the root id. type: - integer - 'null' format: int32 x-go-name: UserId x-go-package: cohesity/iris/server/data/public 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 DatastoreInfo: type: object title: Datastore Information. properties: capacity: description: Specifies the capacity of the datastore in bytes. type: - integer - 'null' format: uint64 x-go-name: Capacity freeSpace: description: Specifies the available space on the datastore in bytes. type: - integer - 'null' format: uint64 x-go-name: FreeSpace x-go-package: cohesity/iris/server/data/public UpdateViewParam: description: Specifies the settings that define a View. type: object title: View. properties: accessSids: description: 'Array of Security Identifiers (SIDs) Specifies the list of security identifiers (SIDs) for the restricted Principals who have access to this View.' type: - array - 'null' items: type: string x-go-name: AccessSids antivirusScanConfig: description: Specifies the antivirus scan config settings for this View. $ref: '#/components/schemas/AntivirusScanConfig' description: description: Specifies an optional text description about the View. type: - string - 'null' x-go-name: Description enableFastDurableHandle: description: 'Specifies whether fast durable handle is enabled. If enabled, view open handle will be kept in memory, which results in a higher performance. But the handles cannot be recovered if node or service crashes.' type: - boolean - 'null' x-go-name: EnableFastDurableHandle enableFilerAuditLogging: description: Specifies if Filer Audit Logging is enabled for this view. type: - boolean - 'null' x-go-name: EnableFilerAuditLogging enableLiveIndexing: description: Specifies whether to enable live indexing for the view. type: - boolean - 'null' x-go-name: EnableLiveIndexing enableMixedModePermissions: description: 'If set, mixed mode (NFS and SMB) access is enabled for this view. This field is deprecated. Use the field SecurityMode. deprecated: true' type: - boolean - 'null' x-go-name: EnableMixedModePermissions enableNfsViewDiscovery: description: If set, it enables discovery of view for NFS. type: - boolean - 'null' x-go-name: EnableNfsViewDiscovery enableOfflineCaching: description: Specifies whether to enable offline file caching of the view. type: - boolean - 'null' x-go-name: EnableOfflineCaching enableSmbAccessBasedEnumeration: description: 'Specifies if access-based enumeration should be enabled. If ''true'', only files and folders that the user has permissions to access are visible on the SMB share for that user.' type: - boolean - 'null' x-go-name: EnableSmbAccessBasedEnumeration enableSmbEncryption: description: 'Specifies the SMB encryption for the View. If set, it enables the SMB encryption for the View. Encryption is supported only by SMB 3.x dialects. Dialects that do not support would still access data in unencrypted format.' type: - boolean - 'null' x-go-name: EnableSmbEncryption enableSmbOplock: description: Specifies whether SMB opportunistic lock is enabled. type: - boolean - 'null' x-go-name: EnableSmbOplock enableSmbViewDiscovery: description: If set, it enables discovery of view for SMB. type: - boolean - 'null' x-go-name: EnableSmbViewDiscovery enforceSmbEncryption: description: 'Specifies the SMB encryption for all the sessions for the View. If set, encryption is enforced for all the sessions for the View. When enabled all future and existing unencrypted sessions are disallowed.' type: - boolean - 'null' x-go-name: EnforceSmbEncryption fileExtensionFilter: description: 'Optional filtering criteria that should be satisfied by all the files created in this view. It does not affect existing files.' $ref: '#/components/schemas/FileExtensionFilter' fileLockConfig: description: 'Optional config that enables file locking for this view. It cannot be disabled during the edit of a view, if it has been enabled during the creation of the view. Also, it cannot be enabled if it was disabled during the creation of the view.' $ref: '#/components/schemas/FileLevelDataLockConfig' logicalQuota: description: 'Specifies an optional logical quota limit (in bytes) for the usage allowed on this View. (Logical data is when the data is fully hydrated and expanded.) This limit overrides the limit inherited from the Storage Domain (View Box) (if set). If logicalQuota is nil, the limit is inherited from the Storage Domain (View Box) (if set). A new write is not allowed if the Storage Domain (View Box) will exceed the specified quota. However, it takes time for the Cohesity Cluster to calculate the usage across Nodes, so the limit may be exceeded by a small amount. In addition, if the limit is increased or data is removed, there may be a delay before the Cohesity Cluster allows more data to be written to the View, as the Cluster is calculating the usage across Nodes.' allOf: - $ref: '#/components/schemas/QuotaPolicy' netgroupWhitelist: description: 'Array of Netgroups. Specifies a list of Netgroups that have permissions to access the View. (Overrides the Netgroups specified at the global Cohesity Cluster level.)' type: - array - 'null' items: $ref: '#/components/schemas/NisNetgroup' x-go-name: NetgroupWhitelist nfsAllSquash: description: Specifies the NFS all squash config. $ref: '#/components/schemas/NfsSquash' nfsRootPermissions: description: Specifies the NFS root permission config of the view file system. $ref: '#/components/schemas/NfsRootPermissions' nfsRootSquash: description: Specifies the NFS root squash config. $ref: '#/components/schemas/NfsSquash' overrideGlobalNetgroupWhitelist: description: 'Specifies whether view level client netgroup whitelist overrides cluster and global setting.' type: - boolean - 'null' x-go-name: OverrideGlobalNetgroupWhitelist overrideGlobalWhitelist: description: 'Specifies whether view level client subnet whitelist overrides cluster and global setting.' type: - boolean - 'null' x-go-name: OverrideGlobalWhitelist protocolAccess: description: 'Specifies the supported Protocols for the View. ''kAll'' enables protocol access to following three views: NFS, SMB and S3. ''kNFSOnly'' enables protocol access to NFS only. ''kSMBOnly'' enables protocol access to SMB only. ''kS3Only'' enables protocol access to S3 only. ''kSwiftOnly'' enables protocol access to Swift only.' type: - string - 'null' enum: - kAll - kNFSOnly - kSMBOnly - kS3Only - kSwiftOnly x-go-name: ProtocolAccess qos: description: Specifies the Quality of Service (QoS) Policy for the View. $ref: '#/components/schemas/QoS' securityMode: description: 'Specifies the security mode used for this view. Currently we support the following modes: Native, Unified and NTFS style. ''kNativeMode'' indicates a native security mode. ''kUnifiedMode'' indicates a unified security mode. ''kNtfsMode'' indicates a NTFS style security mode.' type: - string - 'null' enum: - kNativeMode - kUnifiedMode - kNtfsMode x-go-name: SecurityMode sharePermissions: description: Specifies a list of share level permissions. type: - array - 'null' items: $ref: '#/components/schemas/SmbPermission' x-go-name: SharePermissions smbPermissionsInfo: description: Specifies the SMB permissions for the View. $ref: '#/components/schemas/SmbPermissionsInfo' storagePolicyOverride: description: 'Specifies if inline deduplication and compression settings inherited from the Storage Domain (View Box) should be disabled for this View.' $ref: '#/components/schemas/StoragePolicyOverride' subnetWhitelist: description: 'Array of Subnets. Specifies a list of Subnets with IP addresses that have permissions to access the View. (Overrides the Subnets specified at the global Cohesity Cluster level.)' type: - array - 'null' items: $ref: '#/components/schemas/Subnet' x-go-name: SubnetWhitelist swiftProjectDomain: description: Specifies the Keystone project domain. type: - string - 'null' x-go-name: SwiftProjectDomain swiftProjectName: description: Specifies the Keystone project name. type: - string - 'null' x-go-name: SwiftProjectName tenantId: description: Optional tenant id who has access to this View. type: - string - 'null' x-go-name: TenantId viewLockEnabled: description: 'Specifies whether view lock is enabled. If enabled the view cannot be modified or deleted until unlock. By default it is disabled.' type: - boolean - 'null' x-go-name: ViewLockEnabled x-go-package: cohesity/iris/server/data/public ApplicationsRestoreTaskRequest: description: 'Specifies the request to create a restore task for restoring Application Servers like SQL or Exchange servers hosted by a Protection Source.' type: object title: Create Applications Restore Task Request. required: - name - applicationEnvironment - hostingProtectionSource properties: applicationEnvironment: description: 'Specifies the Environment of the Application to restore like ''kSQL'', or ''kExchange''. overrideDescription: true 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: ApplicationEnvironment applicationRestoreObjects: description: 'Specifies the Application Server objects whose data should be restored and the restore parameters for each of them. This field will be deprecated. Use the field ProtectionSourceAndApplicationRestoreObjects. deprecated: true' type: - array - 'null' items: $ref: '#/components/schemas/ApplicationRestoreObject' x-go-name: ApplicationRestoreObjects hostingProtectionSource: description: 'Specifies the restore information for the Protection Source object that registered and hosts the Application Servers. This provides the snapshot details from which the applications should be restored. This field will be deprecated. Use the field ProtectionSourceAndApplicationRestoreObjects. deprecated: true' $ref: '#/components/schemas/RestoreObjectDetails' name: description: 'Specifies a name for the new task to be created. This field has to be set, and it needs to be unique across all restore tasks.' type: - string - 'null' x-go-name: Name password: description: Specifies password of the username to access the target source. type: - string - 'null' x-go-name: Password protectionSourceAndApplicationObjects: description: 'Specifies the list of hosting protection source and Application restore objects tuple.' type: - array - 'null' items: $ref: '#/components/schemas/ProtectionSourceAndApplicationRestoreObjects' x-go-name: ProtectionSourceAndApplicationObjects username: description: Specifies username to access the target source. type: - string - 'null' x-go-name: Username vlanParameters: description: Specifies VLAN parameters for the restore operation. $ref: '#/components/schemas/VlanParameters' x-go-package: cohesity/iris/server/data/public SmbPermissionsInfo: description: Specifies information about SMB permissions. type: object title: SMB Permissions Information. properties: ownerSid: description: Specifies the security identifier (SID) of the owner of the SMB share. type: - string - 'null' x-go-name: OwnerSid permissions: description: 'Array of SMB Permissions. Specifies a list of SMB permissions.' type: - array - 'null' items: $ref: '#/components/schemas/SmbPermission' x-go-name: Permissions x-go-package: cohesity/iris/server/data/public AdRootTopologyObject: description: Represents a node in AD Topology tree. type: object title: AD Root Topology Object. properties: childObjects: description: Specifies the array of children of this object. type: - array - 'null' items: description: Represents a node in AD Topology tree. type: object title: AD Root Topology Object. (AdRootTopologyObject) x-go-name: ChildObjects description: description: Specifies the 'description' of an object. type: - string - 'null' x-go-name: Description destGuid: description: 'Specifies the guid of matching ''source_guid'' from production AD. This is looked up based on source_guid or distinguishedName attribute value.' type: - string - 'null' x-go-name: DestinationGuid displayName: description: Specifies the display name of the object in AD Topology tree. type: - string - 'null' x-go-name: DisplayName distinguishedName: description: 'Specifies the distinguished name of the object in AD Topology tree. Eg: CN=Jone Doe,OU=Users,DC=corp,DC=cohesity,DC=com' type: - string - 'null' x-go-name: DistinguishedName errorMessage: description: Specifies the AD error while fetching the ADRootTopologyObject. type: - string - 'null' x-go-name: ErrorMessage objectClass: description: 'Specifies the LDAP class name such as ''user'',''computer'', ''organizationalUnit''.' type: - string - 'null' x-go-name: ObjectClass sourceGuid: description: Specifies the guid string of the object in AD snapshot database. type: - string - 'null' x-go-name: SourceGuid x-go-package: cohesity/iris/server/data/public HBaseProtectionSource: description: Specifies an Object representing HBase. type: object title: HBase Protection Source. properties: name: description: Specifies the instance name of the HBase entity. type: - string - 'null' x-go-name: Name tableInfo: description: 'Information of a HBase Table, only valid for an entity of type kTable.' $ref: '#/components/schemas/HBaseTable' type: description: 'Specifies the type of the managed Object in HBase Protection Source. Specifies the type of an HBase source entity. ''kCluster'' indicates a HBase cluster distributed over several physical nodes. ''kNamespace'' indicates a Namespace in the HBase environment. ''kTable'' indicates a Table in the HBase environment.' type: - string - 'null' enum: - kCluster - kNamespace - kTable x-go-name: Type uuid: description: Specifies the UUID for the HBase entity. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public AdObjectRestoreParameters: description: 'AdObjectRestoreParameters are the parameters to restore AD objects from recycle bin or from a mounted AD snapshot database.' type: object title: AD Object Restore Parameters properties: changePasswordOnNextLogon: description: 'Specifies the option for AD ''user'' type of objects to change password when they next logon.' type: - boolean - 'null' x-go-name: ChangePasswordOnNextLogon leaveStateDisabled: description: 'Specifies the option to leave the restored object in disabled state for AD ''account'' type of objects that support disabled state so that admin can do manual inspection before enabling the account. This property has no effect when restoring object from recycle bin. ''User'' and ''Computer'' are AD account types having enable/disable option.' type: - boolean - 'null' x-go-name: LeaveStateDisabled objectGuids: description: 'Specifies the 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: ObjectGuids organizationUnitPath: description: 'Specifies the 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: OrganizationUnitPath password: description: 'Specifies the password 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 in base64 format. 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.' type: - string - 'null' x-go-name: Password x-go-package: cohesity/iris/server/data/public DeployTaskRequest: description: Specifies the settings for a Deploy Task that deploys VMs on cloud. type: object title: Deploy Task Request. required: - name properties: name: description: 'Specifies the name of the Deploy Task. This field must be set and must be a unique name.' type: - string - 'null' x-go-name: Name newParentId: description: 'Specifies 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 target: description: 'Specifies the details about CloudDeploy target where backup snapshots may be converted and stored.' $ref: '#/components/schemas/CloudDeployTargetDetails' x-go-package: cohesity/iris/server/data/public 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 HypervProtectionSource: description: Specifies a Protection Source in HyperV environment. type: object title: HyperV Protection Source. properties: agents: description: 'Array of Agents on the Physical Protection Source. Specifiles the agents running on the HyperV Protection Source and the status information.' type: - array - 'null' items: $ref: '#/components/schemas/AgentInformation' x-go-name: Agents backupType: description: 'Specifies the type of backup supported by the VM. ''kRctBackup'', ''kVssBackup'' Specifies the type of an HyperV datastore object. ''kRctBackup'' indicates backup is done using RCT/checkpoints. ''kVssBackup'' indicates backup is done using VSS.' type: - string - 'null' enum: - kRctBackup - kVssBackup x-go-name: BackupType buildNumber: description: Specifies the build number for HyperV SCVMM Servers. type: - string - 'null' x-go-name: BuildNumber clusterName: description: Specifies the cluster name for 'kHostCluster' objects. type: - string - 'null' x-go-name: ClusterName datastoreInfo: description: Specifies additional information for 'kDatastore' objects. $ref: '#/components/schemas/HypervDatastore' description: description: Specifies a description about the Protection Source. type: - string - 'null' x-go-name: Description hostType: description: 'Specifies host OS type for ''kVirtualMachine'' objects. ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: HostType hypervUuid: description: Specifies the UUID for 'kVirtualMachine' HyperV objects. type: - string - 'null' x-go-name: HypervUuid name: description: Specifies the name of the HyperV Object. type: - string - 'null' x-go-name: Name tagAttributes: description: 'Specifies the list of VM Tag attributes associated with this Object.' type: - array - 'null' items: $ref: '#/components/schemas/TagAttribute' x-go-name: TagAttributes type: description: 'Specifies the type of an HyperV Protection Source Object such as ''kSCVMMServer'', ''kStandaloneHost'', ''kNetwork'', etc. overrideDescription: true Specifies the type of an HyperV Protection Source. ''kSCVMMServer'' indicates a collection of root folders clusters. ''kStandaloneHost'' indicates a single Nutanix cluster. ''kStandaloneCluster'' indicates a single Nutanix cluster. ''kHostGroup'' indicates a Nutanix cluster managed by a Prism Central. ''kHypervHost'' indicates an HyperV host. ''kHostCluster'' indicates a Nutanix cluster managed by a Prism Central. ''kVirtualMachine'' indicates a Virtual Machine. ''kNetwork'' indicates a Virtual Machine network object. ''kDatastore'' represents a storage container object. ''kTag'' indicates a tag type object. ''kCustomProperty'' indicates a custom property including tag type.' type: - string - 'null' enum: - kSCVMMServer - kStandaloneHost - kStandaloneCluster - kHostGroup - kHypervHost - kHostCluster - kVirtualMachine - kNetwork - kDatastore - kTag - kCustomProperty x-go-name: Type uuid: description: 'Specifies the UUID of the Object. This is unique within the HyperV environment.' type: - string - 'null' x-go-name: Uuid vmInfo: description: Specifies additional information for 'kVirtualMachine' objects. $ref: '#/components/schemas/HypervVirtualMachine' windowsVersion: description: Specifies the windows version for HyperV hosts. type: - string - 'null' x-go-name: WindowsVersion x-go-package: cohesity/iris/server/data/public MountVolumeResultDetails: description: 'Specifies the result of mounting an individual mount volume in a Restore Task.' type: object title: Mount Volume Result Details. properties: mountError: description: 'Specifies the cause of the mount failure if the mounting of a volume failed.' allOf: - $ref: '#/components/schemas/RequestError' mountPoint: description: 'Specifies the mount point where the volume is mounted. NOTE: This field may not be populated for VM environments if the onlining of disks is not requested or there was any issue during onlining.' type: - string - 'null' x-go-name: MountPoint volumeName: description: Specifies the name of the original volume. type: - string - 'null' x-go-name: VolumeName x-go-package: cohesity/iris/server/data/public VirtualDiskRecoverTaskState: description: Specifies the complete information about a recover virtual disk task state. type: object title: Virtual Disk Recover State. properties: error: description: 'The error encountered by task (if any). Only valid if the task has finished.' $ref: '#/components/schemas/RequestError' isInstantRecoveryFinished: description: Specifies if instant recovery of the virtual disk is complete. type: - boolean - 'null' x-go-name: IsInstantRecoveryFinished taskState: description: 'Specifies the current state of the restore virtual disks task. Specifies the current state of the restore virtual disks task. ''kDetachDisksDone'' indicates the detached state of disks. ''kSetupDisksDone'' indicates that disks setup is completed. ''kMigrateDisksStarted'' indicates that disks are being migrated. ''kMigrateDisksDone'' indicates that disk migration is completed. ''kUnMountDatastoreDone'' indicates that disk has unmounted the datastore.' type: - string - 'null' enum: - kDetachDisksDone - kSetupDisksDone - kMigrateDisksStarted - kMigrateDisksDone - kUnMountDatastoreDone x-go-name: TaskState virtualDiskRestoreResponse: description: Specifies the response for recovery of virtual disks of a vm. $ref: '#/components/schemas/VirtualDiskRestoreResponse' x-go-package: cohesity/iris/server/data/public 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 FileStatInfo: type: object title: Represents fstat result on a file. properties: backupSourceInodeId: description: Source inode id metadata for certain adapters e.g. Netapp. type: - integer - 'null' format: int64 x-go-name: BackupSourceInodeId mtimeUsecs: description: If this is a file, the mtime as returned by stat. type: - integer - 'null' format: int64 x-go-name: MtimeUsecs size: description: If this is a file, the size of the file as returned by stat. type: - integer - 'null' format: int64 x-go-name: Size type: description: 'The type of this entity. This field will not be populated for ReadDir results, since the DirEntry already contains the type information.' type: - integer - 'null' format: int32 x-go-name: Type x-go-package: yoda/base/yoda.pb FlashBladeNfsInfo: description: 'Specifies information specific to NFS protocol exposed by Pure Flash Blade file system.' type: object title: Flash Blade NFS Information. properties: exportRules: description: 'Specifies NFS protocol export rules. Rules are in the form host(options). host represents one of the following categories: IP address in the form ddd.ddd.ddd.ddd for IPv4, or xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx for IPv6. Netmask in the form ddd.ddd.ddd.ddd/dd for IPv4, or xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx for IPv6. Wildcard in the form * to represent all clients options in parenthesis represents a comma-separated list of NFS export options. Valid export options are rw, ro, root_squash, no_root_squash, and fileid_32bit.' type: - string - 'null' x-go-name: ExportRules x-go-package: cohesity/iris/server/data/public IsilonProtectionSource: description: Specifies a Protection Source in Isilon OneFs environment. type: object title: Isilon Protection Source. properties: accessZone: description: 'Specifies an access zone in an Isilon OneFs file system. This is set only when the entity type is ''kZone''.' $ref: '#/components/schemas/IsilonAccessZone' cluster: description: 'Specifies information of an Isilon OneFs Cluster. This is set only when the entity type is ''kCluster''.' $ref: '#/components/schemas/IsilonCluster' mountPoint: description: 'Specifies information about a mount point in an Isilon OneFs file system. This is set only when the entity type is ''kMountPoint''.' $ref: '#/components/schemas/IsilonMountPoint' name: description: Specifies a unique name of the Protection Source. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of the entity in an Isilon OneFs file system like ''kCluster'', ''kZone'', or, ''kMountPoint''. ''kCluster'' indicates an Isilon OneFs Cluster. ''kZone'' indicates an access zone in an Isilon OneFs Cluster. ''kMountPoint'' indicates a mount point exposed by an Isilon OneFs Cluster.' type: - string - 'null' enum: - kCluster - kZone - kMountPoint x-go-name: Type x-go-package: cohesity/iris/server/data/public GpfsFileset: description: Specifies information about a fileset in a GPFS file system. type: object title: GPFS File Set. properties: id: description: Specifies the id of the fileset. type: - integer - 'null' format: uint64 x-go-name: Id isIndependentFileset: description: If the given fileset is an Independent fileset or not. type: - boolean - 'null' x-go-name: IsIndependentFileset name: description: Name of the filesystem associated with the fileset type: - string - 'null' x-go-name: FilesystemName path: description: Specifies the absolute path of the fileset. type: - string - 'null' x-go-name: Path protocols: description: 'Specifies GPFS supported Protocol information enabled on GPFS File System ''kNfs'' indicates NFS exports in a GPFS fileset. ''kSmb'' indicates CIFS/SMB Shares in a GPFS fileset.' type: - array - 'null' items: type: string enum: - kNfs - kSmb x-go-name: Protocols x-go-package: cohesity/iris/server/data/public HypervRestoreParameters: description: 'Specifies information needed when restoring VMs in HyperV enviroment. This field defines the HyperV specific params for restore tasks of type kRecoverVMs.' type: object title: Hyperv Restore Parameters. properties: datastoreId: 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.' type: - integer - 'null' format: int64 x-go-name: DatastoreId disableNetwork: description: 'Specifies whether the network should be left in disabled state. Attached network is enabled by default. Set this flag to true to disable it.' type: - boolean - 'null' x-go-name: DisableNetwork networkId: description: 'Specifies a network configuration to be attached to the cloned or recovered object. For kCloneVMs and kRecoverVMs tasks, original network configuration is detached if the cloned or recovered object is kept under a different parent Protection Source or a different Resource Pool. By default, for kRecoverVMs task, original network configuration is preserved if the recovered object is kept under the same parent Protection Source and the same Resource Pool. Specify this field to override the preserved network configuration or to attach a new network configuration to the cloned or recovered objects. You can get the networkId of the kNetwork object by setting includeNetworks to ''true'' in the GET /public/protectionSources operation. In the response, get the id of the desired kNetwork object, the resource pool, and the registered parent Protection Source.' type: - integer - 'null' format: int64 x-go-name: NetworkId poweredOn: description: 'Specifies the power state of the cloned or recovered objects. By default, the cloned or recovered objects are powered off.' type: - boolean - 'null' x-go-name: KeepPoweredOn prefix: description: 'Specifies a prefix to prepended to the source object name to derive a new name for the recovered or cloned object. By default, cloned or recovered objects retain their original name. Length of this field is limited to 8 characters.' type: - string - 'null' x-go-name: Prefix preserveTags: description: Specifies whether or not to preserve tags during the operation. type: - boolean - 'null' x-go-name: PreserveTags resourceId: description: 'The resource (HyperV host) to which the restored VM will be attached. 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.' type: - integer - 'null' format: int64 x-go-name: ResourceId suffix: description: 'Specifies a suffix to appended to the original source object name to derive a new name for the recovered or cloned object. By default, cloned or recovered objects retain their original name. Length of this field is limited to 8 characters.' type: - string - 'null' x-go-name: Suffix x-go-package: cohesity/iris/server/data/public CouchbaseProtectionSource: description: Specifies an Object representing Couchbase. type: object title: Couchbase Protection Source. properties: bucketInfo: description: 'Information of a Couchbase Bucket, only valid for an entity of type kBucket.' $ref: '#/components/schemas/CouchbaseBucket' clusterInfo: description: 'Information of a couchbase cluster, only valid for an entity of type kCluster.' $ref: '#/components/schemas/CouchbaseCluster' name: description: Specifies the instance name of the Couchbase entity. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of the managed Object in Couchbase Protection Source. Specifies the type of an Couchbase source entity. ''kCluster'' indicates a Couchbase cluster distributed over several physical nodes. ''kBucket'' indicates a bucket within the Couchbase environment.' type: - string - 'null' enum: - kCluster - kBucket x-go-name: Type uuid: description: Specifies the UUID for the Couchbase entity. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public ClusterNetworkingEndpoint: description: Specifies information about end point. type: object title: Cluster Networking Endpoint. properties: fqdn: description: The Fully Qualified Domain Name. type: - string - 'null' x-go-name: Fqdn ipv4Addr: description: The IPv4 address. type: - string - 'null' x-go-name: Ipv4Addr ipv6Addr: description: The IPv6 address. type: - string - 'null' x-go-name: Ipv6Addr x-go-package: cohesity/iris/server/data/public RestoreObjectState: description: Specifies the state of an individual object in a Restore Task. type: object title: Restore Object State. properties: error: description: Specifies if an error occurred during the restore operation. $ref: '#/components/schemas/RequestError' objectStatus: description: 'Specifies the status of an object during a Restore Task. ''kFilesCloned'' indicates that the cloning has completed. ''kFetchedEntityInfo'' indicates that information about the object was fetched from the primary source. ''kVMCreated'' indicates that the new VM was created. ''kRelocationStarted'' indicates that restoring to a different resource pool has started. ''kFinished'' indicates that the Restore Task has finished. Whether it was successful or not is indicated by the error code that that is stored with the Restore Task. ''kAborted'' indicates that the Restore Task was aborted before trying to restore this object. This can happen if the Restore Task encounters a global error. For example during a ''kCloneVMs'' Restore Task, the datastore could not be mounted. The entire Restore Task is aborted before trying to create VMs on the primary source. ''kDataCopyStarted'' indicates that the disk copy is started. ''kInProgress'' captures a generic in-progress state and can be used by restore operations that don''t track individual states.' type: - string - 'null' enum: - kFilesCloned - kFetchedEntityInfo - kVMCreated - kRelocationStarted - kFinished - kAborted - kDataCopyStarted - kInProgress x-go-name: ObjectStatus resourcePoolId: description: 'Specifies the id of the Resource Pool that the restored object is attached to. For a ''kRecoverVMs'' Restore Task, an object can be recovered back to its original resource pool. This means while recovering a set of objects, this field can reference different resource pools. For a ''kCloneVMs'' Restore Task, all objects are attached to the same resource pool. However, this field will still be populated. NOTE: This field may not be populated if the restore of the object fails.' type: - integer - 'null' format: int64 x-go-name: ResourcePoolId restoredObjectId: description: 'Specifies the Id of the recovered or cloned object. NOTE: For a Restore Task that is recovering or cloning an object in the VMware environment, after the VM is created it is storage vMotioned to its primary datastore. If storage vMotion fails, the Cohesity Cluster marks the recovery task as failed. However, this field is still populated with the id of the recovered VM. This id can be used later to clean up the VM from primary environment (i.e, the vCenter Server).' type: - integer - 'null' format: int64 x-go-name: RestoredObjectId sourceObjectId: description: 'Specifies the Protection Source id of the object to be recovered or cloned.' type: - integer - 'null' format: int64 x-go-name: SourceObjectId x-go-package: cohesity/iris/server/data/public SQLServerInstanceVersion: description: Specifies the Server Instance Version. type: object title: SQL Server Instance Version. properties: build: description: Specifies the build. type: - integer - 'null' format: int32 x-go-name: Build majorVersion: description: Specifies the major version. type: - integer - 'null' format: int32 x-go-name: MajorVersion minorVersion: description: Specifies the minor version. type: - integer - 'null' format: int32 x-go-name: MinorVersion revision: description: Specifies the revision. type: - integer - 'null' format: int32 x-go-name: Revision versionString: description: Specifies the version string. type: - string - 'null' x-go-name: VersionString x-go-package: cohesity/iris/server/data/public HypervVirtualMachine: description: Specifies information about a VirtualMachine Object in HyperV environment. type: object title: HyperV VirtualMachine Object. properties: isHighlyAvailable: description: Specifies whether the VM is Highly Available or not. type: - boolean - 'null' x-go-name: IsHighlyAvailable version: description: Specifies the version of the VM. For example, 8.0, 5.0 etc. type: - string - 'null' x-go-name: Version vmBackupStatus: description: 'Specifies the status of the VM for backup purpose. overrideDescription: true Specifies the backup status of a HyperV Virtual Machine object. ''kSupported'' indicates the agent on the VM can do backup. ''kUnsupportedConfig'' indicates the agent on the VM cannot do backup. ''kMissing'' indicates the VM is not found in SCVMM.' type: - string - 'null' enum: - kSupported - kUnsupportedConfig - kMissing x-go-name: VmBackupStatus vmBackupType: description: 'Specifies the type of backup supported by the VM. overrideDescription: true Specifies the type of an HyperV datastore object. ''kRctBackup'' indicates backup is done using RCT/checkpoints. ''kVssBackup'' indicates backup is done using VSS.' type: - string - 'null' enum: - kRctBackup - kVssBackup x-go-name: VmBackupType x-go-package: cohesity/iris/server/data/public FileExtensionFilter: type: object properties: fileExtensionsList: description: The list of file extensions to apply type: - array - 'null' items: type: string x-go-name: FileExtensionsList isEnabled: description: If set, it enables the file extension filter type: - boolean - 'null' x-go-name: IsEnabled mode: description: 'The mode applied to the list of file extensions ''kWhitelist'' indicates a whitelist extension filter. ''kBlacklist'' indicates a blacklist extension filter.' type: - string - 'null' enum: - kWhitelist - kBlacklist x-go-name: Mode x-go-package: cohesity/iris/server/data/public NasProtectionSource: description: Specifies a Protection Source in a Generic NAS environment. type: object title: Generic NAS Protection Source. properties: description: description: Specifies a description about the Protection Source. type: - string - 'null' x-go-name: Description mountPath: description: 'Specifies the mount path of this NAS. For example, for a NFS mount point, this should be in the format of IP or hostname:/foo/bar.' type: - string - 'null' x-go-name: MountPath name: description: Specifies the name of the NetApp Object. type: - string - 'null' x-go-name: Name protocol: description: 'Specifies the protocol used by the NAS server. Specifies the protocol used by a NAS server. ''kNfs3'' indicates NFS v3 protocol. ''kCifs1'' indicates CIFS v1.0 protocol.' type: - string - 'null' enum: - kNfs3 - kCifs1 x-go-name: Protocol skipValidation: description: Specifies whether to skip validation of the given mount point. type: - boolean - 'null' x-go-name: SkipValidation type: description: 'Specifies the type of a Protection Source Object in a generic NAS Source such as ''kGroup'', or ''kHost''. Specifies the kind of NAS mount. ''kGroup'' indicates top level node that holds individual NAS hosts. ''kHost'' indicates a single NAS path that can be mounted. ''kDfsGroup'' indicates a DFS group containing top level directories mapped to different servers. ''kDfsTopDir'' indicates a top level directory inside a DFS group, discovered when registering a DFS group.' type: - string - 'null' enum: - kGroup - kHost - kDfsGroup - kDfsTopDir x-go-name: Type x-go-package: cohesity/iris/server/data/public SharePointRestoreParameters: description: Specifies information needed for recovering SharePoint Site and items. type: object title: SharePoint Restore Parameters. properties: restoreToOriginalSite: description: Specifies whether the objects are to be restored to the original drive. type: - boolean - 'null' x-go-name: RestoreToOriginalSite siteOwnerList: description: 'Specifies the list of SharePoint Sites whose Document Repositories are being restored.' type: - array - 'null' items: $ref: '#/components/schemas/SiteOwner' x-go-name: SiteOwnerList targetDocumentLibraryName: description: Specifies the target document library name within the alternate site. type: - string - 'null' x-go-name: TargetDocumentLibraryName targetDocumentLibraryPrefix: description: 'Specifies a custom prefix for the document libraries when being restored to the original or an alternate site.' type: - string - 'null' x-go-name: TargetDocumentLibraryPrefix targetSite: description: 'Specifies the target site where the recovery of the entire Site or the Site items is to be done.' $ref: '#/components/schemas/ProtectionSource' x-go-package: cohesity/iris/server/data/public DagInfo: description: Specifies the information about the DAG(Database availability group). type: object title: Exchange DAG Information properties: dagApplicationServerInfoList: description: 'Specifies the status of all the Exchange Application Servers that are part of this DAG.' type: - array - 'null' items: $ref: '#/components/schemas/DagApplicationServerInfo' x-go-name: DagApplicationServerInfoList exchangeDagProtectionPreference: description: 'Specifies information about the preference order while choosing between which database copy of the database which is part of DAG should be protected.' $ref: '#/components/schemas/ExchangeDAGProtectionPreference' guid: description: Specifies Unique GUID for the DAG. type: - string - 'null' x-go-name: Guid name: description: Specifies display name of the DAG. type: - string - 'null' x-go-name: Name x-go-package: cohesity/iris/server/data/public HypervCloneParameters: description: 'Specifies information needed when cloning VMs in HyperV enviroment. This field defines the HyperV specific params for restore tasks of type kCloneVMs.' type: object title: Hyperv Clone Parameters. properties: disableNetwork: description: 'Specifies whether the network should be left in disabled state. Attached network is enabled by default. Set this flag to true to disable it.' type: - boolean - 'null' x-go-name: DisableNetwork networkId: description: 'Specifies a network configuration to be attached to the cloned or recovered object. For kCloneVMs and kRecoverVMs tasks, original network configuration is detached if the cloned or recovered object is kept under a different parent Protection Source or a different Resource Pool. By default, for kRecoverVMs task, original network configuration is preserved if the recovered object is kept under the same parent Protection Source and the same Resource Pool. Specify this field to override the preserved network configuration or to attach a new network configuration to the cloned or recovered objects. You can get the networkId of the kNetwork object by setting includeNetworks to ''true'' in the GET /public/protectionSources operation. In the response, get the id of the desired kNetwork object, the resource pool, and the registered parent Protection Source.' type: - integer - 'null' format: int64 x-go-name: NetworkId poweredOn: description: 'Specifies the power state of the cloned or recovered objects. By default, the cloned or recovered objects are powered off.' type: - boolean - 'null' x-go-name: KeepPoweredOn prefix: description: 'Specifies a prefix to prepended to the source object name to derive a new name for the recovered or cloned object. By default, cloned or recovered objects retain their original name. Length of this field is limited to 8 characters.' type: - string - 'null' x-go-name: Prefix preserveTags: description: Specifies whether or not to preserve tags during the operation. type: - boolean - 'null' x-go-name: PreserveTags resourceId: description: 'The resource (HyperV host) to which the restored VM will be attached. 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.' type: - integer - 'null' format: int64 x-go-name: ResourceId suffix: description: 'Specifies a suffix to appended to the original source object name to derive a new name for the recovered or cloned object. By default, cloned or recovered objects retain their original name. Length of this field is limited to 8 characters.' type: - string - 'null' x-go-name: Suffix x-go-package: cohesity/iris/server/data/public AdObjectMetaData: description: Specifies details about the AD objects. type: object title: AD object Meta Data. properties: distinguishedName: description: Specifies the Distinguished name of the AD object. type: - string - 'null' x-go-name: DistinguishedName domain: description: Domain of the AD object. type: - string - 'null' x-go-name: Domain email: description: Specifies the email of the AD object of type user or group. type: - string - 'null' x-go-name: Email guid: description: Specifies the Guid of the AD object. type: - string - 'null' x-go-name: Guid name: description: Specifies the name of the AD object. type: - string - 'null' x-go-name: Name objectType: description: 'Specifies the type of the AD Object. The type may be user, computer, group or ou.' type: - string - 'null' x-go-name: ObjectType samAccountName: description: Specifies the sam account name of the AD object. type: - string - 'null' x-go-name: SamAccountName x-go-package: cohesity/iris/server/data/public OneDriveDocumentMetadata: description: Specifies the metadata for the OneDrive document. type: object title: OneDrive document metadata. properties: documentType: description: 'Specifies the type of OneDrive document(file/folder). Specifies the OneDrive document type. ''kFile'' specifies a file. ''kFolder'' specifies a folder.' type: - string - 'null' enum: - kFile - kFolder x-go-name: DocumentType x-go-package: cohesity/iris/server/data/public FileLevelDataLockConfig: description: 'Specifies a config to lock files in a view - to protect from malicious or an accidental attempt to delete or modify the files in this view.' type: object title: File Level Data Lock Configurations. properties: autoLockAfterDurationIdle: description: 'Specifies the duration to lock a file that has not been accessed or modified (ie. has been idle) for a certain duration of time in milliseconds. Do not set if it is required to disable auto lock.' type: - integer - 'null' format: uint64 x-go-name: AutoLockAfterDurationIdleMsecs defaultFileRetentionDurationMsecs: description: 'Specifies a global default retention duration for files in this view, if file lock is enabled for this view. Also, it is a required field if file lock is enabled. Set to -1 if the required default retention period is forever.' type: - integer - 'null' format: int64 x-go-name: DefaultRetentionDurationMsecs expiryTimestampMsecs: description: Specifies a definite timestamp in milliseconds for retaining the file. type: - integer - 'null' format: uint64 x-go-name: ExpiryTimestampMsecs lockingProtocol: description: 'Specifies the supported mechanisms to explicity lock a file from NFS/SMB interface. Supported locking protocols: kSetReadOnly, kSetAtime. ''kSetReadOnly'' is compatible with Isilon/Netapp behaviour. This locks the file and the retention duration is determined in this order: 1) atime, if set by user/application and within min and max retention duration. 2) Min retention duration, if set. 3) Otherwise, file is switched to expired data automatically. ''kSetAtime'' is compatible with Data Domain behaviour.' type: - string - 'null' enum: - kSetReadOnly - kSetAtime x-go-name: LockingProtocol maxRetentionDurationMsecs: description: 'Specifies a maximum duration in milliseconds for which any file in this view can be retained for. Set to -1 if the required retention duration is forever. If set, it should be greater than or equal to the default retention period as well as the min retention period.' type: - integer - 'null' format: int64 x-go-name: MaxRetentionDurationMsecs minRetentionDurationMsecs: description: 'Specifies a minimum retention duration in milliseconds after a file gets locked. The file cannot be modified or deleted during this timeframe. Set to -1 if the required retention duration is forever. This should be set less than or equal to the default retention duration.' type: - integer - 'null' format: int64 x-go-name: MinRetentionDurationMsecs mode: description: 'Specifies the mode of file level datalock. Enterprise mode can be upgraded to Compliance mode, but Compliance mode cannot be downgraded to Enterprise mode. kCompliance: This mode would disallow all user to delete/modify file or view under any condition when it ''s in locked status except for deleting view when the view is empty. kEnterprise: This mode would follow the rules as compliance mode for normal users. But it would allow the storage admin (1) to delete view or file anytime no matter it is in locked status or expired. (2) to rename the view (3) to bring back the retention period when it''s in locked mode A lock mode of a file in a view can be in one of the following: ''kCompliance'': Default mode of datalock, in this mode, Data Security Admin cannot modify/delete this view when datalock is in effect. Data Security Admin can delete this view when datalock is expired. ''kEnterprise'' : In this mode, Data Security Admin can change view name or delete view when datalock is in effect. Datalock in this mode can be upgraded to ''kCompliance'' mode.' type: - string - 'null' enum: - kCompliance - kEnterprise x-go-name: Mode x-go-package: cohesity/iris/server/data/public UpdateRestoreTaskParams: description: 'UpdateRestoreTaskParams holds the information to update a Restore Task in Magneto.' type: object properties: adOptions: description: Specifies the Active Directory options to update the Restore Task with. $ref: '#/components/schemas/AdRestoreOptions' enableAutoSync: description: Enables Auto Sync feature for SQL Multi-stage Restore task. type: - boolean - 'null' x-go-name: EnableAutoSync restoreTaskId: description: Specifies the ID of the existing Restore Task to update. type: - integer - 'null' format: int64 x-go-name: RestoreTaskId sqlOptions: description: 'Specifies the sql options to update the Restore Task with. Specifies the action type of multi stage SQL restore. ''kCreate'' specifies the create action for a restore. ''kUpdate'' specifies the user action to update an ongoing restore. ''kFinalize'' specifies the user action to finalize a restore.' type: - string - 'null' enum: - kCreate - kUpdate - kFinalize x-go-name: SqlOptions x-go-package: cohesity/iris/server/data/public RootPublicFolder: description: 'Specifies the RootPublicFolder with restore details to support full or partial recovery.' type: object title: O365 RootPublicFolder. properties: publicFolderList: description: 'Specifies the list of Public Folders to be restored incase user wishes not to restore entire RootPublicFolder.' type: - array - 'null' items: $ref: '#/components/schemas/PublicFolder' x-go-name: PublicFolderList restoreEntireRootPublicFolder: description: Specifies whether the entire RootPublicFolder is to be restored. type: - boolean - 'null' x-go-name: RestoreEntireRootPublicFolder rootPublicFolderObject: description: Specifies the details of the RootPublicFolder object. $ref: '#/components/schemas/RestoreObjectDetails' x-go-package: cohesity/iris/server/data/public FleetParams: description: Specifies various resources when deploying a VM to Fleet instances. type: object title: Fleet Parameters. properties: fleetNetworkParams: description: Specifies the network params for the fleet. $ref: '#/components/schemas/FleetNetworkParams' fleetSubnetType: description: 'Specifies the subnet type of the fleet. Specifies the type of the fleet subnet. ''kCluster'' implies same subnet as of Cluster, valid only for Cloud Edition cluster. ''kSourceVM'' implies same subnet as of source vm. ''kCustom'' implies the custome subnet.' type: - string - 'null' enum: - kCluster - kSourceVM - kCustom x-go-name: FleetSubnetType fleetTags: description: Specifies the tag information for the fleet. type: - array - 'null' items: $ref: '#/components/schemas/FleetTag' x-go-name: FleetTags x-go-package: cohesity/iris/server/data/public FleetNetworkParams: description: Specifies the various network params for the fleet. type: object title: Fleet Network Parameters. properties: region: description: Specifies the region for the fleet. type: - string - 'null' x-go-name: Region subnet: description: Specifies the subnet for the fleet. type: - string - 'null' x-go-name: Subnet vpc: description: Specifies the vpc for the fleet. type: - string - 'null' x-go-name: Vpc x-go-package: cohesity/iris/server/data/public ExchangeDatabaseInfo: description: Specifies the information about the Exchange Database. type: object title: Exchange Database Information properties: appServerId: description: 'Specifies the entity id of the Exchange Application Server which has this database copy.' type: - integer - 'null' format: int64 x-go-name: AppServerId backupSupported: description: Specifies if backup is supported for the Exchange database copy. type: - boolean - 'null' x-go-name: BackupSupported backupUnsupportedReasons: description: Specifies any reason(s) for Exchange database backup not supported. type: - array - 'null' items: type: string x-go-name: BackupUnsupportedReasons createdTimeMsecs: description: 'Specifies the time when the database is created in Unix epoch time in milliseconds.' type: - integer - 'null' format: int64 x-go-name: CreatedTimeMsecs databaseState: description: 'Specifies the state of the Exchange database copy. Specifies the state of Exchange Database Copy. ''kUnknown'' indicates the status is not known. ''kMounted'' indicates the exchange database copy is mounted and healthy. ''kError'' indicates the exchange database copy is unmounted or partially mounted or is in error state.' type: - string - 'null' enum: - kUnknown - kMounted - kError x-go-name: DatabaseState dbSizeBytes: description: Specifies the size of the Exchange database copy in bytes. type: - integer - 'null' format: int64 x-go-name: DbSizeBytes dbguid: description: Specifies the guid of the Exchange Database. type: - string - 'null' x-go-name: DbGuid name: description: Specifes the name of the Exchange Database. type: - string - 'null' x-go-name: Name ownerId: description: 'Specifies the owner entity id of the Exchange Application Server which has this database copy.' type: - integer - 'null' format: int64 x-go-name: OwnerId utcOffsetMin: description: Specifies UTC time offset of database creation time. type: - integer - 'null' format: int64 x-go-name: UtcOffsetMin x-go-package: cohesity/iris/server/data/public VMwareProtectionSource: description: Specifies a Protection Source in a VMware environment. type: object title: VMware Protection Source. properties: agentId: description: Specifies the id of the persistent agent. type: - integer - 'null' format: int64 x-go-name: AgentId agents: description: 'Specifies the list of agent information on the Virtual Machine. This is set only if the Virtual Machine has persistent agent.' type: - array - 'null' items: $ref: '#/components/schemas/AgentInformation' x-go-name: Agents connectionState: description: 'Specifies the connection state of the Object and are only valid for ESXi hosts (''kHostSystem'') or Virtual Machines (''kVirtualMachine''). These enums are equivalent to the connection states documented in VMware''s reference documentation. Examples of Cohesity connection states include ''kConnected'', ''kDisconnected'', ''kInacccessible'', etc. ''kConnected'' indicates that server has access to virtual machine. ''kDisconnected'' indicates that server is currently disconnected to virtual machine. ''kInaccessible'' indicates that one or more configuration files are inacccessible. ''kInvalid'' indicates that virtual machine configuration is invalid. ''kOrphaned'' indicates that virtual machine is no longer registered on the host it is associated with. ''kNotResponding'' indicates that virtual machine has failed to respond due to external issues such as network connectivity, host not running etc.' type: - string - 'null' enum: - kConnected - kDisconnected - kInaccessible - kInvalid - kOrphaned - kNotResponding x-go-name: ConnectionState datastoreInfo: description: Specifies additional information of entities of type 'kDatastore'. $ref: '#/components/schemas/DatastoreInfo' folderType: description: 'Specifies the folder type for the ''kFolder'' Object. ''kVMFolder'' indicates folder can hold VMs or vApps. ''kHostFolder'' indicates folder can hold hosts and compute resources. ''kDatastoreFolder'' indicates folder can hold datastores and storage pods. ''kNetworkFolder'' indicates folder can hold networks and switches. ''kRootFolder'' indicates folder can hold datacenters.' type: - string - 'null' enum: - kVMFolder - kHostFolder - kDatastoreFolder - kNetworkFolder - kRootFolder x-go-name: FolderType hasPersistentAgent: description: 'Set to true if a persistent agent is running on the Virtual Machine. This is populated for entities of type ''kVirtualMachine''.' type: - boolean - 'null' x-go-name: HasPersistentAgent hostType: description: 'Specifies the host type for the ''kVirtualMachine'' Object. ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: HostType id: description: Specifies the UUID of the VMware Protection Source. $ref: '#/components/schemas/VMwareObjectId' ipDetails: description: This field can be used to capture IP Addresses for entities that have it. $ref: '#/components/schemas/IpDetails' isVmTemplate: description: IsTemplate specifies if the VM is a template or not. type: - boolean - 'null' x-go-name: IsVmTemplate name: description: Specifies a human readable name of the Protection Source. type: - string - 'null' x-go-name: Name tagAttributes: description: 'Specifies the optional list of VM Tag attributes associated with this Object.' type: - array - 'null' items: $ref: '#/components/schemas/TagAttribute' x-go-name: TagAttributes toolsRunningStatus: description: 'Specifies the status of VMware Tools for the guest OS on the VM. This is only valid for the ''kVirtualMachine'' type. ''kGuestToolsRunning'' means the VMware tools are running on the guest OS. ''kGuestToolsNotRunning'' means the VMware tools are not running on the guest OS. ''kUnknown'' means the state of the VMware tools on the guest OS is not known. ''kGuestToolsExecutingScripts'' means the guest OS is currently executing scripts using VMware tools.' type: - string - 'null' enum: - kUnknown - kGuestToolsExecutingScripts - kGuestToolsNotRunning - kGuestToolsRunning x-go-name: VMwareToolsRunningStatus type: description: 'Specifies the type of managed Object in a VMware Protection Source. Examples of VMware Objects include ''kVCenter'', ''kFolder'', ''kDatacenter'', ''kResourcePool'', ''kDatastore'', ''kVirtualMachine'', etc. ''kVCenter'' indicates the vCenter entity in a VMware protection source type. ''kFolder indicates the folder entity (of any kind) in a VMware protection source type. ''kDatacenter'' indicates the datacenter entity in a VMware protection source type. ''kComputeResource'' indicates the physical compute resource entity in a VMware protection source type. ''kResourcePool'' indicates the set of physical resources within a compute resource or cloudcompute resource. ''kDataStore'' indicates the datastore entity in a VMware protection source type. ''kHostSystem'' indicates the ESXi host entity in a VMware protection source type. ''kVirtualMachine'' indicates the virtual machine entity in a VMware protection source type. ''kVirtualApp'' indicates the virtual app entity in a VMware protection source type. ''kStandaloneHost'' indicates the standalone ESXi host entity (not managed by vCenter) in a VMware protection source type. ''kStoragePod'' indicates the storage pod entity in a VMware protection source type. ''kNetwork'' indicates the standard vSwitch in a VMware protection source type. ''kDistributedVirtualPortgroup'' indicates a distributed vSwitch port group in a VMware protection source type. ''kTagCategory'' indicates a tag category entity in a VMware protection source type. ''kTag'' indicates a tag entity in a VMware protection source type. ''kOpaqueNetwork'' indicates an opaque network which is created and managed by an entity outside of vSphere. ''kvCloudDirector'' indicates a vCloud director entity in a VMware protection source type. ''kOrganization'' indicates an Organization under a vCD in a VMware protection source type. ''kVirtualDatacenter'' indicates a virtual datacenter entity in a VMware protection source type. ''kCatalog'' indicates a VCD catalog entity in a VMware protection source type. ''kOrgMetadata'' indicates an VCD organization metadata in a VMware protection source type. ''kStoragePolicy'' indicates a storage policy associated with the vApp in a VMware protection source type.' type: - string - 'null' enum: - kVCenter - kFolder - kDatacenter - kComputeResource - kClusterComputeResource - kResourcePool - kDatastore - kHostSystem - kVirtualMachine - kVirtualApp - kStandaloneHost - kStoragePod - kNetwork - kDistributedVirtualPortgroup - kTagCategory - kTag - kOpaqueNetwork - kvCloudDirector - kOrganization - kVirtualDatacenter - kCatalog - kOrgMetadata - kStoragePolicy x-go-name: Type vCloudDirectorInfo: description: Specifies an array of vCenters to be registered type: - array - 'null' items: $ref: '#/components/schemas/VCloudDirectorInfo' x-go-name: VCloudDirectorInfo version: description: 'For vCenter and ESXi, this will show the software version. For VMs, this will show the hardware version.' type: - string - 'null' x-go-name: Version virtualDisks: description: 'Specifies an array of virtual disks that are part of the Virtual Machine. This is populated for entities of type ''kVirtualMachine''.' type: - array - 'null' items: $ref: '#/components/schemas/VirtualDiskInfo' x-go-name: VirtualDisks x-go-package: cohesity/iris/server/data/public FilePartitionBlock: description: 'Defines a leaf node of a device tree. This refers to a logical partition in a virtual disk file.' type: object title: File Partition Block. properties: diskFileName: description: Specifies the disk file name where the logical partition is. type: - string - 'null' x-go-name: DiskFileName lengthBytes: description: Specifies the length of the block in bytes. type: - integer - 'null' format: int64 x-go-name: LengthBytes number: description: Specifies a unique number of the partition within the linear disk file. type: - integer - 'null' format: int64 x-go-name: Number offsetBytes: description: 'Specifies the offset of the block (in bytes) from the beginning of the containing object such as a physical disk or a virtual disk file.' type: - integer - 'null' format: int64 x-go-name: OffsetBytes x-go-package: cohesity/iris/server/data/public AdAttribute: description: 'Represnts the information about the AD attribute of the object. It also contains information regarding whether it is system attribute and whether the attribute is equal on both Snapshot and Production AD.' type: object title: AdAttribute properties: adAttributeFlags: description: 'Specifies the flags related to the attribute of the AD object. ''kEqual'' indicates the attribute value of AD object from Snapshot and Production AD are equal. ''kNotEqual'' indicates the attribute value of AD object from Snapshot and Production AD are not equal. ''kNotFound'' indicates attribute of the AD object is missing from both Snapshot and Production AD. ''kSystem'' indicates this is system attribute. This can only be updated by the AD internal component. ''kMultiValue'' indicates that the attribute is mutli-value attribute. This attribute supports mutli-value merge during attribute restore operation.' type: - array - 'null' items: type: string enum: - kEqual - kNotEqual - kNotFound - kSystem - kMultiValue x-go-name: AdAttributeFlags destinationValue: description: 'Specifies the value of the attribute of the AD object present on the Production AD.' $ref: '#/components/schemas/AttributeValue' errorMessage: description: Specifies the error message regarding the attribute type: - string - 'null' x-go-name: ErrorMessage name: description: Specifies the name of the attribute of the AD object. type: - string - 'null' x-go-name: Name sameValue: description: 'Specifies the value of the attribute of the AD object here if attribute is equal on both Snapshot and Production AD. I' $ref: '#/components/schemas/AttributeValue' sourceValue: description: 'Specifies the value of the attribute of the AD object present on the Snapshot AD.' $ref: '#/components/schemas/AttributeValue' x-go-package: cohesity/iris/server/data/public LatencyThresholds: description: 'Specifies latency thresholds that trigger throttling for all datastores found in the registered Protection Source or specific to one datastore.' type: object title: Latency Thresholds. properties: activeTaskMsecs: description: 'If the latency of a datastore is above this value, existing backup tasks using the datastore are throttled.' type: - integer - 'null' format: int64 x-go-name: ActiveTaskMsecs newTaskMsecs: description: 'If the latency of a datastore is above this value, then new backup tasks using the datastore will not be started.' type: - integer - 'null' format: int64 x-go-name: NewTaskMsecs x-go-package: cohesity/iris/server/data/public TimeRangeSettings: description: Specifies the time range struct. type: object title: Time Range. properties: endTimeUsecs: description: 'Specifies the end time specified as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: EndTimeUsecs jobUid: description: 'Specifies the job whose finished runs can be used to restore any point within this time range.' $ref: '#/components/schemas/UniversalId' startTimeUsecs: description: 'Specifies the start time specified as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: StartTimeUsecs x-go-package: cohesity/iris/server/data/public ADObject: description: Represents the details about an AD object. type: object title: AD Object properties: description: description: Specifies the 'description' of an AD object. type: - string - 'null' x-go-name: Description destinationGuid: description: 'Specifies the guid of object in the Production AD which is equivalent to the object in the Snapshot AD.' type: - string - 'null' x-go-name: DestinationGuid displayName: description: Specifies the display name of the AD object. type: - string - 'null' x-go-name: DisplayName distinguishedName: description: 'Specifies the distinguished name of the AD object. Eg: CN=Jone Doe,OU=Users,DC=corp,DC=cohesity,DC=com' type: - string - 'null' x-go-name: DistinguishedName errorMessage: description: Specifies the error message while fetching the AD object. type: - string - 'null' x-go-name: ErrorMessage objectClass: description: 'Specifies the class name of an AD Object such as ''user'',''computer'', ''organizationalUnit''.' type: - string - 'null' x-go-name: ObjectClass searchResultFlags: description: 'Specifies the SearchResultFlags of the AD object. ''kEqual'' indicates the AD Object from Snapshot and Production AD are equal. ''kNotEqual'' indicates the AD Object from snapshot and production AD are not equal. ''kRestorePasswordRequired'' indicates when restoring this AD Object from Snapshot AD to Production AD, a password is required. ''kMovedOnDestination'' indicates the object has moved to another container or OU in Production AD compared to Snapshot AD. ''kDisableSupported'' indicates the enable and disable is supported on the AD Object. AD Objects of type ''User'' and ''Computers'' support this operation.' type: - array - 'null' items: type: string enum: - kEqual - kNotEqual - kRestorePasswordRequired - kMovedOnDestination - kDisableSupported x-go-name: SearchResultFlags sourceGuid: description: Specifies the guid of the AD object in Snapshot AD. type: - string - 'null' x-go-name: SourceGuid x-go-package: cohesity/iris/server/data/public LogicalVolume: description: Specifies attributes for a kLVM (Linux) or kLDM (Windows) filesystem. type: object title: Logical Volume. properties: deviceRootNode: description: 'Specifies the device tree defining how to combine partitions to create this logical volume.' $ref: '#/components/schemas/DeviceTreeDetails' groupName: description: Specifies the group name of the logical volume. type: - string - 'null' x-go-name: GroupName groupUuid: description: Specifies the group uuid of the logical volume. type: - string - 'null' x-go-name: GroupUuid name: description: Specifies the name of the logical volume. type: - string - 'null' x-go-name: Name uuid: description: Specifies the uuid of the logical volume. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public RestoreInfo: description: Specifies the info regarding a full SQL snapshot. type: object title: Full Snapshot Information. properties: archivalTarget: description: Specifies the info related to the archival target. $ref: '#/components/schemas/ArchivalExternalTarget' attemptNumber: description: Specifies the attempt number. type: - integer - 'null' format: int32 x-go-name: AttemptNumber cloudDeployTarget: description: Specifies the info related to the cloud deploy target. $ref: '#/components/schemas/CloudDeployTargetDetails' jobRunId: description: Specifies the id of the job run. type: - integer - 'null' format: int64 x-go-name: JobRunId jobUid: description: Specifies the universal id for the job. $ref: '#/components/schemas/UniversalId' parentSource: description: Specifies the parent source related information. $ref: '#/components/schemas/ProtectionSource' restoreTimeUsecs: description: 'This field specifies the time in to which the object needs to be restored. This filed is only applicable when object is being backeup using CDP feature.' type: - integer - 'null' format: int64 x-go-name: RestoreTimeUsecs snapshotRelativeDirPath: description: Specifies the relative path of the snapshot directory. type: - string - 'null' x-go-name: SnapshotRelativeDirPath source: description: Specifies the info related to the entity. $ref: '#/components/schemas/ProtectionSource' startTimeUsecs: description: 'Specifies the start time specified as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: StartTimeUsecs viewName: description: Specifies the name of the view. type: - string - 'null' x-go-name: ViewName vmHadIndependentDisks: description: Specifies if the VM had independent disks. type: - boolean - 'null' x-go-name: VmHadIndependentDisks x-go-package: cohesity/iris/server/data/public RestoredFileInfoList: type: object title: Specifies information on file/directory being restored. properties: isDirectory: description: Specifies whether the path points to directory. type: - boolean - 'null' x-go-name: IsDirectory x-go-package: cohesity/iris/server/data/public SiteDriveItem: description: Specifies details about a Site's Drive item. type: object title: Site Drive Item. properties: isFileItem: description: Specifies whether the current item is a file or not. type: - boolean - 'null' x-go-name: IsFileItem itemId: description: Specifies the Id of the Drive item. type: - string - 'null' x-go-name: ItemId itemPath: description: Specifies the path of the Drive item within the drive. type: - string - 'null' x-go-name: ItemPath x-go-package: cohesity/iris/server/data/public HBaseTable: description: Specifies an Object containing information about a HBase table. type: object title: HBase Table Info. properties: approxSizeBytes: description: Specifies the approx size of the table in bytes. type: - integer - 'null' format: int64 x-go-name: ApproxSizeBytes x-go-package: cohesity/iris/server/data/public RestoreFilesTaskRequest: description: 'Specifies information about a Restore Task that recovers files and folders.' type: object title: Restore Task. properties: continueOnError: description: 'Specifies if the Restore Task should continue even if the copy operation of some files and folders fails. If true, the Cohesity Cluster ignores intermittent errors and recovers as many files and folders as possible. If false, the Restore Task stops recovering when a copy operation fails.' type: - boolean - 'null' x-go-name: ContinueOnError fileRecoveryMethod: description: 'Specifies the type of method to be used to perform file recovery. ''kAutoDeploy'' indicates that file restore operation wiil be performed using an ephemeral agent. ''kUseExistingAgent'' indicates that file restore operation wiil be performed using an persistent agent. ''kUseHypervisorAPIs'' indicates that file restore operation wiil be performed using an hypervisor API''s.' type: - string - 'null' enum: - kAutoDeploy - kUseExistingAgent - kUseHypervisorAPIs x-go-name: FileRecoveryMethod filenames: description: 'Array of Files or Folders. Specifies the files and folders to recover from the snapshot.' type: - array - 'null' items: type: string x-go-name: Filenames isFileBasedVolumeRestore: description: Specifies whether this is a file based volume restore. type: - boolean - 'null' x-go-name: IsFileBasedVolumeRestore mountDisksOnVm: description: 'Sepcifies 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 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 newBaseDirectory: description: 'Specifies an optional root folder where to recover the selected files and folders. By default, files and folders are restored to their original path.' type: - string - 'null' x-go-name: NewBaseDirectory overwrite: description: 'If true, any existing files and folders on the operating system are overwritten by the recovered files or folders. This is the default. If false, existing files and folders are not overwritten.' type: - boolean - 'null' x-go-name: Overwrite password: description: Specifies password of the username to access the target source. type: - string - 'null' x-go-name: Password preserveAttributes: description: 'If true, the Restore Tasks preserves the original file and folder attributes. This is the default.' type: - boolean - 'null' x-go-name: PreserveAttributes restoredFileInfoList: description: Specifies information regarding files and directories. type: - array - 'null' items: $ref: '#/components/schemas/RestoredFileInfoList' x-go-name: RestoredFileInfoList sourceObjectInfo: description: 'Specifies information about the source object (such as a VM) that contains the files and folders to recover. In addition, it contains information about the Protection Job and Job Run that captured the snapshot to recover from. 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.' title: Restore Object. allOf: - $ref: '#/components/schemas/RestoreObjectDetails' targetHostType: description: 'Specifies the target host types to be restored. ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: TargetHostType targetParentSourceId: description: 'Specifies the registered source (such as a vCenter Server) that contains the target protection source (such as a VM) where the files and folders are recovered to. This field is not required for a Physical Server.' type: - integer - 'null' format: int64 x-go-name: TargetParentSourceId targetSourceId: description: 'Specifies the id of the target protection source (such as a VM) where the files and folders are recovered to.' type: - integer - 'null' format: int64 x-go-name: TargetSourceId useExistingAgent: description: 'Specifies whether this will use an existing agent on the target vm to do restore. Following field is deprecated and shall not be used. Please refer to the FileRecoveryMethod field for more information.' type: - boolean - 'null' x-go-name: UseExistingAgent username: description: Specifies username to access the target source. type: - string - 'null' x-go-name: Username x-go-package: cohesity/iris/server/data/public 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 OracleDataGuardInfo: description: 'Specifies information about the Database in Oracle DataGuard configuration. Data GUard provides a comprehensive set of services that create, maintain, and monitor one or more standby databases to enable production Oracle databases to survive disasters and data corruptions. Data Guard maintains these standby databases as transactionally consistent copies of the production databases.' type: object title: Oracle Data Guard Configuration Info. properties: role: description: 'Specifies the role of the DataGuard database. Specifies the role of the DataGuard database. A Data Guard configuration contains one production database, also referred to as the primary database, that functions in the primary role. The primary database can be either a single-instance Oracle database or an Oracle Real Application Clusters database. A standby database is a transactionally consistent copy of the primary database. Similar to a primary database, a standby database can be either a single-instance Oracle database or an Oracle Real Application Clusters database. ''kPrimary'' indicates that the current database is primary database. ''kStandby'' indicates that the current database is standby database.' type: - string - 'null' enum: - kPrimary - kStandby x-go-name: Role type: description: 'Specifies the type of standby database. Specifies the type of standby database. ''kPhysical'' indicates that the current database provides a physically identical copy of the primary database, with on disk structures identical to the primary database on a block-for-block basis. It is kept synchronized with the primary database, though Redo Apply, which recovers the redo data received from the primary database and applies the redo to the physical standby database. ''kLogical'' indicates that the current database provides the same logical information as the production database, although the physical structure can be different. It is kept synchronized with the primary database thorugh SQL Apply, which transforms the data in the redo received from the primary database into SQL statements and then executing the SQL statements on the standby database. ''kSnapshot'' indicates that the current database is a fully updateable standby created by converting a physical standby database into a snasphot standby database. It receives and archives but does not apply redo data from a primary database.' type: - string - 'null' enum: - kPhysical - kLogical - kSnapshot x-go-name: Type x-go-package: cohesity/iris/server/data/public ApplicationRestoreObject: description: 'Specifies the Application Server to restore and parameters specific to that application.' type: object title: Application Server object to restore. properties: adRestoreParameters: description: Specifies parameters specific to Active Directory Application Server. $ref: '#/components/schemas/AdRestoreParameters' applicationServerId: description: Specifies the Application Server to restore (for example, kSQL). type: - integer - 'null' format: int64 x-go-name: ApplicationServerId exchangeRestoreParameters: description: Specifies parameters speicific to Exchange Application Server. $ref: '#/components/schemas/ExchangeRestoreParameters' sqlRestoreParameters: description: Specifies parameters specific to this Application Server. $ref: '#/components/schemas/SqlRestoreParameters' targetHostId: description: 'Specifies the target host if the application is to be restored to a different host. If this is empty, then the application is restored to the original host, which is the hosting Protection Source.' type: - integer - 'null' format: int64 x-go-name: TargetHostId targetRootNodeId: description: 'Specifies the registered root node, like vCenter, of targetHost. If this is empty, then it is assumed the root node of the target host is the same as the host Protection Source of the application.' type: - integer - 'null' format: int64 x-go-name: TargetRootNodeId x-go-package: cohesity/iris/server/data/public MongoDBDatabase: description: Specifies an Object containing information about a mongodb database. type: object title: MongoDB Database Info. properties: sizeBytes: description: Size of this Database. type: - integer - 'null' format: int64 x-go-name: SizeBytes x-go-package: cohesity/iris/server/data/public FileSearchResults: description: 'Specifies an array of found files and folders. In addition, a count is provided to indicate if additional requests must be made to get the full result.' type: object title: File/Folder Search Result. properties: files: description: 'Array of Files and Folders. Specifies the list of files and folders returned by this request that match the specified search and filter criteria. The number of files returned is limited by the pageCount field.' type: - array - 'null' items: $ref: '#/components/schemas/FileSearchResult' x-go-name: Files paginationCookie: description: 'Specifies cookie for resuming search if pagination is being used. For Librarian queries only.' type: - string - 'null' x-go-name: PaginationCookie totalCount: description: 'Specifies the total number of files and folders that match the filter and search criteria. Use this value to determine how many additional requests are required to get the full result.' type: - integer - 'null' format: int64 x-go-name: TotalCount x-go-package: cohesity/iris/server/data/public VirtualDiskRestoreParameters: description: Specifies the parameters to recover virtual disks of a vm. type: object title: Virtual Disk Restore Parameters. properties: powerOffVmBeforeRecovery: description: Specifies whether to power off the VM before recovering virtual disks. type: - boolean - 'null' x-go-name: PowerOffVmBeforeRecovery powerOnVmAfterRecovery: description: Specifies whether to power on the VM after recovering virtual disks. type: - boolean - 'null' x-go-name: PowerOnVmAfterRecovery targetSourceId: description: Specifies the target entity to which the disks should be attached. type: - integer - 'null' format: int64 x-go-name: TargetSourceId virtualDiskMappings: description: Specifies the list of virtual disks mappings. type: - array - 'null' items: $ref: '#/components/schemas/VirtualDiskMapping' x-go-name: VirtualDiskMappings x-go-package: cohesity/iris/server/data/public DiskPartition: description: Specifies information about each partition in a physical disk. type: object title: Disk Partition. properties: lengthBytes: description: Specifies the length of the block in bytes. type: - integer - 'null' format: int64 x-go-name: LengthBytes number: description: Specifies a unique number of the partition within the linear disk file. type: - integer - 'null' format: int64 x-go-name: Number offsetBytes: description: 'Specifies the offset of the block (in bytes) from the beginning of the containing object such as a physical disk or a virtual disk file.' type: - integer - 'null' format: int64 x-go-name: OffsetBytes typeUuid: description: 'Specifies the partition type uuid. If disk is unpartitioned, this field is not set. If disk is MBR partitioned, this field is set to a partition type. If disk is GPT partitioned, this field is set to a partition type GUID.' type: - string - 'null' x-go-name: TypeUuid uuid: description: 'Specifies the partition uuid. If disk is unpartitioned, this field is not set. If disk is MBR partitioned, this field is not set. If disk is GPT partitioned, this field is set to a partition GUID.' type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public IsilonMountPoint: description: Specifies information about a mount point in an Isilon OneFs Cluster. type: object title: Isilon Mount Point. properties: accessZoneName: description: Specifies the name of access zone. type: - string - 'null' x-go-name: AccessZoneName nfsMountPoint: description: 'Specifies information about an NFS export. This field is set if the file system supports protocol type ''kNfs''.' $ref: '#/components/schemas/IsilonNfsMountPoint' path: description: 'Specifies the path of the access zone in ifs. This should include the leading "/ifs/".' type: - string - 'null' x-go-name: Path protocols: description: 'List of Protocols on Isilon. Specifies the list of protocols enabled on Isilon OneFs file system. ''kNfs'' indicates NFS exports in an Isilon Cluster. ''kSmb'' indicates CIFS/SMB Shares in an Isilon Cluster.' type: - array - 'null' items: type: string enum: - kNfs - kSmb x-go-name: Protocols smbMountPoints: description: 'Specifies information about an SMB share. This field is set if the file system supports protocol type ''kSmb''.' type: - array - 'null' items: $ref: '#/components/schemas/IsilonSmbMountPoint' x-go-name: SmbMountPoints x-go-package: cohesity/iris/server/data/public AwsFleetParams: description: Specifies various resources when deploying a VM to Fleet instances. type: object title: AWS Fleet Parameters. properties: fleetSubnetType: description: 'Specifies the subnet type of the fleet. Specifies the type of the fleet subnet. ''kCluster'' implies same subnet as of Cluster, valid only for Cloud Edition cluster. ''kSourceVM'' implies same subnet as of source vm. ''kCustom'' implies the custome subnet.' type: - string - 'null' enum: - kCluster - kSourceVM - kCustom x-go-name: FleetSubnetType fleetTags: description: Specifies the tag information for the fleet. type: - array - 'null' items: $ref: '#/components/schemas/FleetTag' x-go-name: FleetTags networkParamsList: description: Specifies the list of network params for the fleet. type: - array - 'null' items: $ref: '#/components/schemas/FleetNetworkParams' x-go-name: NetworkParamsList x-go-package: cohesity/iris/server/data/public VirtualDiskInformation: type: object title: Specifies information about the virtual disk. properties: busNumber: description: Specifies the Id of the controller bus that controls the disk. type: - integer - 'null' format: int64 x-go-name: BusNumber controllerType: description: Specifies the controller type like SCSI, or IDE etc. type: - string - 'null' x-go-name: ControllerType diskId: description: 'Specifies original disk id. This is sufficient to identify the disk information, but in some scenarios, users may specify the controller option instead.' type: - string - 'null' x-go-name: DiskId diskLocation: description: 'Specifies location of the disk, e.g. this will contain the location of datastore in VMware environment.' $ref: '#/components/schemas/ProtectionSource' diskSizeInBytes: description: Specifies size of the virtual disk in bytes. type: - integer - 'null' format: int64 x-go-name: DiskSizeInBytes filePath: description: Specifies the original file path if applicable. type: - string - 'null' x-go-name: FilePath mountPoints: description: Specifies the list of mount points. type: - array - 'null' items: type: string x-go-name: MountPoints unitNumber: description: 'Specifies the disk file name. This is the VMDK name and not the flat file name.' type: - integer - 'null' format: int64 x-go-name: UnitNumber x-go-package: cohesity/iris/server/data/public FilesAndFoldersInfo: description: 'FilesAndFolders specifies the metadata information about the files and(or) folders for creating a download task.' type: object title: File and Folders Information. properties: absolutePath: description: AbsolutePath specifies the absolute path of the specified file or folder. type: - string - 'null' x-go-name: AbsolutePath isDirectory: description: IsDirectory specifies if specified object is a directory or not. type: - boolean - 'null' x-go-name: IsDirectory x-go-package: cohesity/iris/server/data/public 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 AdObjectsRestoreStatus: description: 'Represents the details about the status of restore of the AD objects. It also has details about the number of objects whose restore is successfull, failure or in progress.' type: object title: Ad Objects Restore Status. properties: adObjectsRestoreInfo: description: 'Specifies the status of all the AD Objects which were requested to be restored.' type: - array - 'null' items: $ref: '#/components/schemas/AdObjectRestoreInformation' x-go-name: AdObjectsRestoreInfo numObjectsFailed: description: Specifies the number of AD Objects whose restore is in progress. type: - integer - 'null' format: int32 x-go-name: NumObjectsRunning numObjectsSucceeded: description: Specifies the number of AD Objects whose restore is successfull. type: - integer - 'null' format: int32 x-go-name: NumObjectsSucceeded x-go-package: cohesity/iris/server/data/public NisNetgroup: description: Defines an NIS Netgroup. type: object title: Netgroup properties: description: description: Description of the netgroup. type: - string - 'null' x-go-name: Description domain: description: Specifies the domain of the netgroup. type: - string - 'null' x-go-name: Domain name: description: Specifies the name of the netgroup. type: - string - 'null' x-go-name: Name nfsAccess: description: 'Specifies whether clients from this netgroup can mount using NFS protocol. Protocol access level. ''kDisabled'' indicates Protocol access level ''Disabled'' ''kReadOnly'' indicates Protocol access level ''ReadOnly'' ''kReadWrite'' indicates Protocol access level ''ReadWrite''' type: - string - 'null' enum: - kDisabled - kReadOnly - kReadWrite x-go-name: NfsAccess nfsSquash: description: Specifies the NFS squash type. type: - integer - 'null' format: int32 x-go-name: NfsSquash x-go-package: cohesity/iris/server/data/public NfsRootPermissions: description: Specifies the config of NFS root permission of a view file system. type: object title: NfsRootPermissions properties: gid: description: Unix GID for the root of the file system. type: - integer - 'null' format: uint32 x-go-name: Gid mode: description: Unix mode bits for the root of the file system. type: - integer - 'null' format: uint32 x-go-name: Mode uid: description: Unix UID for the root of the file system. type: - integer - 'null' format: uint32 x-go-name: Uid x-go-package: cohesity/iris/server/data/public VirtualDiskMappingResponse: description: 'Specifies information about virtual disks where a user can specify mappings of source disk and destination disk to overwrite.' type: object title: Virtual Disk Mapping Response. properties: diskToOverwrite: description: 'Specifies information about disk which user wants to overwrite. If specified, then powerOffVmBeforeRecovery must be true.' $ref: '#/components/schemas/VirtualDiskIdInformation' sourceDisk: description: Specifies information about the source disk. $ref: '#/components/schemas/VirtualDiskIdInformation' targetLocation: description: 'Specifies the target location information, for e.g. a datastore in VMware environment. If diskToOverwrite is specified, then the target location is automatically deduced.' $ref: '#/components/schemas/ProtectionSource' 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 SearchProductionAdObjectsRequest: description: Specifies the request to search AD objects from Production AD. type: object title: Search production AD objects request. properties: distinguishedNames: description: Specifies the list of the distinguished names of the AD objects. type: - array - 'null' items: type: string x-go-name: DistinguishedNames objectGuids: description: Specifies the list of the guids of the AD objects. type: - array - 'null' items: type: string x-go-name: ObjectGuids protectionSourceId: description: 'ProtectionSourceId is the Id of the Domain Controller host on which we want to search for AD objects.' type: - integer - 'null' format: int64 x-go-name: ProtectionSourceId samAccountNames: description: Specifies the list of the sam account names of the AD objects. type: - array - 'null' items: type: string x-go-name: SamAccountNames x-go-package: cohesity/iris/server/data/public OneDriveRestoreParameters: description: Specifies information needed for recovering Drive(s) & Drive items. type: object title: OneDrive Restore Parameters. properties: driveOwnerList: description: 'Specifies the list of Drive owners which are to be restored along with the details of their drives.' type: - array - 'null' items: $ref: '#/components/schemas/OneDriveOwner' x-go-name: DriveOwnerList restoreToOriginalDrive: description: Specifies whether the objects are to be restored to the original drive. type: - boolean - 'null' x-go-name: RestoreToOriginalDrive targetDriveId: description: 'Specifies the Drive Id of the target user where the OneDrive items are to be recovered.' type: - string - 'null' x-go-name: TargetDriveId targetFolderPath: description: 'Specifies the target folder path within the drive where recovery has to be done.' type: - string - 'null' x-go-name: TargetFolderPath targetUser: description: 'Specifies the target user where the recovery of the entire OneDrive or the OneDrive items is to be done.' $ref: '#/components/schemas/ProtectionSource' x-go-package: cohesity/iris/server/data/public FileSearchResult: description: Specifies details about the found file or folder. type: object title: File/Folder Search Result. properties: adObjectMetaData: description: Specifies the metadata about the AD objects. $ref: '#/components/schemas/AdObjectMetaData' documentType: description: Specifies the inferred document type. type: - string - 'null' x-go-name: DocumentType emailMetaData: description: Specifies the metadata about the Outlook Emails. $ref: '#/components/schemas/EmailMetaData' fileVersions: description: 'Array of File Versions. Specifies the different snapshot versions of a file or folder that were captured at different times.' type: - array - 'null' items: $ref: '#/components/schemas/FileVersion' x-go-name: FileVersions filename: description: Specifies the name of the found file or folder. type: - string - 'null' x-go-name: Filename isFolder: description: 'Specifies if the found item is a folder. If true, the found item is a folder.' type: - boolean - 'null' x-go-name: IsFolder jobId: description: 'Specifies the Job id for the Protection Job that is currently associated with object that contains the backed up file or folder. If the file or folder was backed up on current Cohesity Cluster, this field contains the id for the Job that captured the object that contains the file or folder. If the file or folder was backed up on a Primary Cluster and replicated to this Cohesity Cluster, a new Inactive Job is created, the object that contains the file or folder is now associated with new Inactive Job, and this field contains the id of the new Inactive Job.' type: - integer - 'null' format: int64 x-go-name: JobId jobUid: description: 'Specifies the universal id of the Protection Job that backed up the object that contains the file or folder.' allOf: - $ref: '#/components/schemas/UniversalId' oneDriveDocumentMetadata: description: Specifies the metadata about the OneDrive documents. $ref: '#/components/schemas/OneDriveDocumentMetadata' protectionSource: description: Specifies the Protection Source to which the file or folder belongs. $ref: '#/components/schemas/ProtectionSource' registeredSourceId: description: 'Specifies the id of the top-level registered source (such as a vCenter Server) where the source object that contains the the file or folder is stored.' type: - integer - 'null' format: int64 x-go-name: RegisteredSourceId sharepointDocumentMetadata: description: Specifies the metadata about the Sharepoint documents. $ref: '#/components/schemas/SharepointDocumentMetadata' snapshotTags: description: Snapshot tags present on this document type: - array - 'null' items: type: string x-go-name: SnapshotTags sourceId: description: Specifies the source id of the object that contains the file or folder. type: - integer - 'null' format: int64 x-go-name: SourceId tags: description: Tags present on this document. type: - array - 'null' items: type: string x-go-name: Tags tagsToSnapshotsMap: description: Mapping from snapshot tags to. type: - object - 'null' additionalProperties: type: array items: type: integer format: int64 x-go-name: TagsToSnapshotsMap type: description: Specifies the type of the file document such as KDirectory, kFile, etc. type: - string - 'null' enum: - kDirectory - kFile - kEmail - kSymlink x-go-name: Type viewBoxId: description: 'Specifies the id of the Domain (View Box) where the source object that contains the file or folder is stored.' type: - integer - 'null' format: int64 x-go-name: ViewBoxId x-go-package: cohesity/iris/server/data/public ClusterNetworkingResourceInformation: description: Specifies a resource with IP address. type: object title: Cluster Networking Resource Information. properties: endpoints: description: The endpoints by which the resource is accessible. type: - array - 'null' items: $ref: '#/components/schemas/ClusterNetworkingEndpoint' x-go-name: EndpointVec type: description: The type of the resource. type: - string - 'null' x-go-name: Type x-go-package: cohesity/iris/server/data/public SnapshotAttempt: description: Specifies information about a single snapshot. type: object title: Snapshot Attempt. properties: attemptNumber: description: 'Specifies the number of the attempts made by the Job Run to capture a snapshot of the object. For example, if an snapshot is successfully captured after three attempts, this field equals 3.' type: - integer - 'null' format: int64 x-go-name: AttemptNumber jobRunId: description: Specifies the id of the Job Run that captured the snapshot. type: - integer - 'null' format: int64 x-go-name: JobRunId 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 AntivirusScanConfig: description: Specifies the antivirus scan config settings for this View. type: object title: Antivirus scan config properties: blockAccessOnScanFailure: description: Specifies whether block access to the file when antivirus scan fails. type: - boolean - 'null' x-go-name: BlockAccessOnScanFailure isEnabled: description: Specifies whether the antivirus service is enabled or not. type: - boolean - 'null' x-go-name: IsEnabled maximumScanFileSize: description: 'Specifies maximum file size that will be sent to antivirus server for scanning. if greater than zero, the file size that exceeds this size would be skipped from virus scan.' type: - integer - 'null' format: int64 x-go-name: MaximumScanFileSize scanFilter: description: 'Files extension that meets these filter criteria will be sent to antivirus server for the scan.' $ref: '#/components/schemas/FileExtensionFilter' scanOnAccess: description: Specifies whether to scan a file when it is opened. type: - boolean - 'null' x-go-name: ScanOnAccess scanOnClose: description: Specifies whether to scan a file when it is closed after modify. type: - boolean - 'null' x-go-name: ScanOnClose scanTimeoutUsecs: description: 'Specifies the maximum amount of time that a scan can take before timing out.' type: - integer - 'null' format: int32 x-go-name: ScanTimeoutUsecs x-go-package: cohesity/iris/server/data/public VCloudDirectorInfo: type: object title: VCloudDirectorInfo Information. properties: endpoint: description: vCenter endpoint. type: - string - 'null' x-go-name: Endpoint name: description: vCenter name. type: - string - 'null' x-go-name: Name x-go-package: cohesity/iris/server/data/public VmVolumesInformation: description: Specifies information about a logical volume found a VM. type: object title: VM Volume Information. properties: filesystemVolumes: description: 'Array of Filesystem Volumes. Specifies information about the filesystem volumes found in a logical volume.' type: - array - 'null' items: $ref: '#/components/schemas/FilesystemVolume' x-go-name: FilesystemVolumes x-go-package: cohesity/iris/server/data/public CassandraCluster: description: Specifies an Object containing information about a Cassandra cluster. type: object title: Cassandra Cluster Info. properties: primaryHost: description: Primary host from this Cassandra cluster. type: - string - 'null' x-go-name: PrimaryHost seeds: description: Seeds of this Cassandra Cluster. type: - array - 'null' items: type: string x-go-name: Seeds x-go-package: cohesity/iris/server/data/public SqlProtectionSource: description: Specifies an Object representing one SQL Server instance or database. type: object title: SQL Protection Source. properties: IsAvailableForVssBackup: description: 'Specifies whether the database is marked as available for backup according to the SQL Server VSS writer. This may be false if either the state of the databases is not online, or if the VSS writer is not online. This field is set only for type ''kDatabase''.' type: - boolean - 'null' createdTimestamp: description: 'Specifies the time when the database was created. It is displayed in the timezone of the SQL server on which this database is running.' type: - string - 'null' x-go-name: CreatedTimestamp databaseName: description: 'Specifies the database name of the SQL Protection Source, if the type is database.' type: - string - 'null' x-go-name: DatabaseName dbAagEntityId: description: 'Specifies the AAG entity id if the database is part of an AAG. This field is set only for type ''kDatabase''.' type: - integer - 'null' format: int64 x-go-name: DbAagEntityId dbAagName: description: 'Specifies the name of the AAG if the database is part of an AAG. This field is set only for type ''kDatabase''.' type: - string - 'null' x-go-name: DbAagName dbCompatibilityLevel: description: 'Specifies the versions of SQL server that the database is compatible with.' type: - integer - 'null' format: int64 x-go-name: DbCompatibilityLevel dbFileGroups: description: 'Specifies the information about the set of file groups for this db on the host. This is only set if the type is kDatabase.' type: - array - 'null' items: type: string x-go-name: DbFileGroups dbFiles: description: 'Specifies the last known information about the set of database files on the host. This field is set only for type ''kDatabase''.' type: - array - 'null' items: $ref: '#/components/schemas/DbFileInfo' x-go-name: DbFiles dbOwnerUsername: description: Specifies the name of the database owner. type: - string - 'null' x-go-name: DbOwnerUsername id: description: Specifies an id that identifies an SQL Object. $ref: '#/components/schemas/SqlSourceId' name: description: Specifies the instance name of the SQL Protection Source type: - string - 'null' x-go-name: Name ownerId: description: Specifies the id of the container VM for the SQL Protection Source. type: - integer - 'null' format: int64 x-go-name: OwnerId recoveryModel: description: 'Specifies the Recovery Model for the database in SQL environment. Only meaningful for the ''kDatabase'' SQL Protection Source. Specifies the Recovery Model set for the Microsoft SQL Server. ''kSimpleRecoveryModel'' indicates the Simple SQL Recovery Model which does not utilize log backups. ''kFullRecoveryModel'' indicates the Full SQL Recovery Model which requires log backups and allows recovery to a single point in time. ''kBulkLoggedRecoveryModel'' indicates the Bulk Logged SQL Recovery Model which requires log backups and allows high-performance bulk copy operations.' type: - string - 'null' enum: - kSimpleRecoveryModel - kFullRecoveryModel - kBulkLoggedRecoveryModel x-go-name: RecoveryModel sqlServerDbState: description: 'The state of the database as returned by SQL Server. Indicates the state of the database. The values correspond to the ''state'' field in the system table sys.databases. See https://goo.gl/P66XqM. ''kOnline'' indicates that database is in online state. ''kRestoring'' indicates that database is in restore state. ''kRecovering'' indicates that database is in recovery state. ''kRecoveryPending'' indicates that database recovery is in pending state. ''kSuspect'' indicates that primary filegroup is suspect and may be damaged. ''kEmergency'' indicates that manually forced emergency state. ''kOffline'' indicates that database is in offline state. ''kCopying'' indicates that database is in copying state. ''kOfflineSecondary'' indicates that secondary database is in offline state.' type: - string - 'null' enum: - kOnline - kRestoring - kRecovering - kRecoveryPending - kSuspect - kEmergency - kOffline - kCopying - kOfflineSecondary x-go-name: SqlServerDbState sqlServerInstanceVersion: description: The version of the SQL instance. $ref: '#/components/schemas/SQLServerInstanceVersion' type: description: 'Specifies the type of the managed Object in a SQL Protection Source. Examples of SQL Objects include ''kInstance'' and ''kDatabase''. ''kInstance'' indicates that SQL server instance is being protected. ''kDatabase'' indicates that SQL server database is being protected. ''kAAG'' indicates that SQL AAG (AlwaysOn Availability Group) is being protected. ''kAAGRootContainer'' indicates that SQL AAG''s root container is being protected. ''kRootContainer'' indicates root container for SQL sources.' type: - string - 'null' enum: - kInstance - kDatabase - kAAG - kAAGRootContainer - kRootContainer x-go-name: Type x-go-package: cohesity/iris/server/data/public OraclePluggableDatabaseInfo: description: 'Specifies the informatiomn about the pluggable database. A Pluggabele Database(PDB) is a portable collection of schemas, schema objects, and nonschema objects that appears to an Oracle Net client as a non-CDB.' type: object properties: databaseId: description: Specifies the ID of the Pluggable Database. type: - string - 'null' x-go-name: DatabaseId name: description: Speicifes the name of the Pluggable Database. type: - string - 'null' x-go-name: Name openMode: description: 'Specifies the OPEN_MODE information. Specifies the OPEN_MODE type for the Oracle database. ''kMounted'' indicates that the database is open in Mounted mode. ''kReadWrite'' indicates that the database is open in R/W mode. ''kReadOnly'' indicates that the database is open in ReadOnly mode. ''kMigrate'' inidcates that the database is open in Migrate mode.' type: - string - 'null' enum: - kMounted - kReadWrite - kReadOnly - kMigrate x-go-name: OpenMode sizeBytes: description: Specifies the Size in Bytes of the Pluggable Database. type: - integer - 'null' format: int64 x-go-name: SizeBytes x-go-package: cohesity/iris/server/data/public SanVolume: description: Specifies a SAN Volume in a SAN Storage Array. type: object title: SAN Volume. properties: createdTime: description: Specifies the created time (e.g., "2015-07-21T17:59:41Z") of the volume. type: - string - 'null' x-go-name: CreatedTime parentVolume: description: 'Specifies the name of the source volume, if this volume was copied or cloned from it.' type: - string - 'null' x-go-name: ParentVolume serialNumber: description: Specifies the serial number of the volume. type: - string - 'null' x-go-name: SerialNumber sizeBytes: description: Specifies the provisioned size in bytes of the volume. type: - integer - 'null' format: int64 x-go-name: SizeBytes usedBytes: description: Specifies the total space actually used by the volume. type: - integer - 'null' format: int64 x-go-name: UsedBytes x-go-package: cohesity/iris/server/data/public VmwareRestoreParameters: description: Specifies the information required for recovering or cloning VmWare VMs. type: object title: VmWare Restore Parameters. properties: additionalDatastoreIds: description: Specifies additional datastores where the object should be recovered to. type: - array - 'null' items: type: integer format: int64 x-go-name: AdditionalDatastoreIds datastoreFolderId: description: 'Specifies the folder where the restore datastore should be created. This is applicable only when the VMs are being cloned.' type: - integer - 'null' format: int64 x-go-name: DatastoreFolderId datastoreId: description: 'Specifies the datastore where the object''s files should be recovered to. This field is mandatory to recover objects to a different resource pool or to a different parent source. If not specified, objects are recovered to their original datastore locations in the parent source.' type: - integer - 'null' format: int64 x-go-name: DatastoreId detachNetwork: description: 'Specifies whether the network should be detached from the recovered or cloned VMs.' type: - boolean - 'null' x-go-name: DetachNetwork disableNetwork: description: 'Specifies whether the network should be left in disabled state. Attached network is enabled by default. Set this flag to true to disable it.' type: - boolean - 'null' x-go-name: DisableNetwork networkId: description: 'Specifies a network configuration to be attached to the cloned or recovered object. For kCloneVMs and kRecoverVMs tasks, original network configuration is detached if the cloned or recovered object is kept under a different parent Protection Source or a different Resource Pool. By default, for kRecoverVMs task, original network configuration is preserved if the recovered object is kept under the same parent Protection Source and the same Resource Pool. Specify this field to override the preserved network configuration or to attach a new network configuration to the cloned or recovered objects. You can get the networkId of the kNetwork object by setting includeNetworks to ''true'' in the GET /public/protectionSources operation. In the response, get the id of the desired kNetwork object, the resource pool, and the registered parent Protection Source.' type: - integer - 'null' format: int64 x-go-name: NetworkId networkMappings: description: 'Specifies the parameters for mapping the source and target networks. This field can be used if restoring to a different parent source. This will replace the NetworkId and DisableNetwork that are used to provide configuration for a single network. Unless the support for mapping is available for all the entities old keys can be used to attach a new network. Supports ''kVMware'' for now.' type: - array - 'null' items: $ref: '#/components/schemas/NetworkMapping' x-go-name: NetworkMappings poweredOn: description: 'Specifies the power state of the cloned or recovered objects. By default, the cloned or recovered objects are powered off.' type: - boolean - 'null' x-go-name: KeepPoweredOn prefix: description: 'Specifies a prefix to prepended to the source object name to derive a new name for the recovered or cloned object. By default, cloned or recovered objects retain their original name. Length of this field is limited to 8 characters.' type: - string - 'null' x-go-name: Prefix preserveCustomAttributesDuringClone: description: 'Specifies whether or not to preserve the custom attributes during the clone operation. The default behavior is ''true''.' type: - boolean - 'null' x-go-name: PreserveCustomAttributesDuringClone preserveTags: description: 'Specifies whether or not to preserve tags during the clone operation. The default behavior is ''true''.' type: - boolean - 'null' x-go-name: PreserveTags recoveryProcessType: description: 'Specifies the type of recovery process to be performed. If unspecified, then an instant recovery will be performed. Specifies the recovery process type to be used.. ''kInstantRecovery'' indicates that an instant recovery should be performed. ''kCopyRecovery'' indicates that a copy recovery should be performed.' type: - string - 'null' enum: - kInstantRecovery - kCopyRecovery x-go-name: RecoveryProcessType resourcePoolId: description: 'Specifies the resource pool where the cloned or recovered objects are attached. This field is mandatory for kCloneVMs Restore Tasks always. For kRecoverVMs Restore Tasks, this field is mandatory only if newParentId field is specified. If this field is not specified, recovered objects are attached to the original resource pool under the original parent.' type: - integer - 'null' format: int64 x-go-name: ResourcePoolId storageProfileName: description: 'Specifies the name of the destination storage profile while restoring to an alternate VCD location.' type: - string - 'null' x-go-name: StorageProfileName storageProfileVcdUuid: description: 'Specifies the UUID of the storage profile while restoring to an alternate VCD location.' type: - string - 'null' x-go-name: StorageProfileVcdUuid suffix: description: 'Specifies a suffix to appended to the original source object name to derive a new name for the recovered or cloned object. By default, cloned or recovered objects retain their original name. Length of this field is limited to 8 characters.' type: - string - 'null' x-go-name: Suffix vAppId: description: Specifies the ID of the vApp to which a VM should be restored. type: - integer - 'null' format: int64 x-go-name: VAppId vdcId: description: Specifies the ID of the VDC to which a VM should be restored. type: - integer - 'null' format: int64 x-go-name: VdcId vmFolderId: description: 'Specifies a folder where the VMs should be restored. This is applicable only when the VMs are being restored to an alternate location or if clone is being performed.' type: - integer - 'null' format: int64 x-go-name: VmFolderId x-go-package: cohesity/iris/server/data/public NetappClusterInfo: description: Specifies information about a NetApp Cluster Protection Source. type: object title: NetApp Cluster Information. properties: contactInfo: description: 'Specifies information about the contact for the NetApp cluster such as a name, phone number, and email address.' type: - string - 'null' x-go-name: ContactInfo location: description: 'Specifies where this NetApp cluster is located. This location identification string is configured by the NetApp system administrator. This field does not contain the NetApp cluster hostname or IP address.' type: - string - 'null' x-go-name: Location serialNumber: description: 'Specifies the serial number of the NetApp cluster in the format: x-xx-xxxxxx.' type: - string - 'null' x-go-name: SerialNumber x-go-package: cohesity/iris/server/data/public PublicFolder: description: Specifies the O365 PublicFolder details. type: object title: O365 PublicFolder. properties: folderId: description: Specifies the unique ID of the folder. type: - string - 'null' x-go-name: FolderId publicFolderItemIdList: description: 'Specifies the PublicFolder items within the folder to be restored incase the user wishes not to restore the entire folder.' type: - array - 'null' items: type: string x-go-name: PublicFolderItemIdList restoreEntireFolder: description: Specifies whether the entire folder is to be restored. type: - boolean - 'null' x-go-name: RestoreEntireFolder x-go-package: cohesity/iris/server/data/public RegisteredSourceInfo: description: Specifies information about a registered Source. type: object title: Registered Source Info. properties: accessInfo: description: 'Specifies the parameters required to establish a connection with a particular environment.' $ref: '#/components/schemas/ConnectorParameters' authenticationErrorMessage: description: 'Specifies an authentication error message. This indicates the given credentials are rejected and the registration of the source is not successful.' type: - string - 'null' x-go-name: AuthenticationErrorMessage authenticationStatus: description: 'Specifies the status of the authenticating to the Protection Source when registering it with Cohesity Cluster. If the status is ''kFinished'' and there is no error, registration is successful. Specifies the status of the authentication during the registration of a Protection Source. ''kPending'' indicates the authentication is in progress. ''kScheduled'' indicates the authentication is scheduled. ''kFinished'' indicates the authentication is completed. ''kRefreshInProgress'' indicates the refresh is in progress.' type: - string - 'null' enum: - kPending - kScheduled - kFinished - kRefreshInProgress x-go-name: AuthenticationStatus blacklistedIpAddresses: description: 'Specifies the list of IP Addresses on the registered source to be blacklisted for doing any type of IO operations.' type: - array - 'null' items: type: string x-go-name: BlacklistedIpAddresses cassandraParams: description: 'Contains all the additional params specified by the user while registering the Cassandra source.' $ref: '#/components/schemas/CassandraConnectParams' couchbaseParams: description: 'Contains all the additional params specified by the user while registering the Couchbase source.' $ref: '#/components/schemas/CouchbaseConnectParams' environments: description: 'Specifies a list of applications environment that are registered with this Protection Source such as ''kSQL''. 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: - array - 'null' items: type: string 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: Environments hbaseParams: description: 'Contains all the additional params specified by the user while registering the HBase source.' $ref: '#/components/schemas/HBaseConnectParams' hdfsParams: description: 'Contains all the additional params specified by the user while registering the Hdfs source.' $ref: '#/components/schemas/HdfsConnectParams' hiveParams: description: 'Contains all the additional params specified by the user while registering the Hive source.' $ref: '#/components/schemas/HiveConnectParams' isDbAuthenticated: description: 'Specifies if application entity dbAuthenticated or not. ex: oracle database.' type: - boolean - 'null' x-go-name: IsDbAuthenticated minimumFreeSpaceGB: description: 'Specifies the minimum free space in GiB of the space expected to be available on the datastore where the virtual disks of the VM being backed up. If the amount of free space(in GiB) is lower than the value given by this field, backup will be aborted. Note that this field is applicable only to ''kVMware'' type of environments.' type: - integer - 'null' format: int64 x-go-name: MinimumFreeSpaceGB mongodbParams: description: 'Contains all the additional params specified by the user while registering the MongoDB source.' $ref: '#/components/schemas/MongoDBConnectParams' nasMountCredentials: description: 'Specifies the credentials required to mount directories on the NetApp server if given.' title: NAS Server Credentials. allOf: - $ref: '#/components/schemas/NasMountCredentialParams' office365CredentialsList: description: 'Office365 Source Credentials. Specifies credentials needed to authenticate & authorize user for Office365.' type: - array - 'null' items: $ref: '#/components/schemas/Office365Credentials' x-go-name: Office365CredentialsList office365Region: description: Specifies the region for Office365. type: - string - 'null' x-go-name: Office365Region password: description: Specifies password of the username to access the target source. type: - string - 'null' x-go-name: Password refreshErrorMessage: description: 'Specifies a message if there was any error encountered during the last rebuild of the Protection Source tree. If there was no error during the last rebuild, this field is reset.' type: - string - 'null' x-go-name: RefreshErrorMessage refreshTimeUsecs: description: 'Specifies the Unix epoch time (in microseconds) when the Protection Source tree was most recently fetched and built.' type: - integer - 'null' format: int64 x-go-name: RefreshTimeUsecs registeredAppsInfo: description: 'Specifies information of the applications registered on this protection source.' type: - array - 'null' items: $ref: '#/components/schemas/RegisteredAppInfo' x-go-name: RegisteredAppsInfo registrationTimeUsecs: description: 'Specifies the Unix epoch time (in microseconds) when the Protection Source was registered.' type: - integer - 'null' format: int64 x-go-name: RegistrationTimeUsecs subnets: description: 'Specifies the list of subnets added during creation or updation of vmare source. Currently, this field will only be populated in case of VMware registration.' type: - array - 'null' items: $ref: '#/components/schemas/Subnet' x-go-name: Subnets throttlingPolicy: description: 'Specifies the throttling policy that should be applied to all datastores under this registered Protection Source.' $ref: '#/components/schemas/ThrottlingPolicyParameters' throttlingPolicyOverrides: description: 'Array of Throttling Policy Overrides for Datastores. Specifies a list of Throttling Policy for datastores that override the common throttling policy specified for the registered Protection Source. For datastores not in this list, common policy will still apply.' type: - array - 'null' items: $ref: '#/components/schemas/ThrottlingPolicyOverride' x-go-name: ThrottlingPolicyOverrides useOAuthForExchangeOnline: description: 'Specifies whether OAuth should be used for authentication in case of Exchange Online.' type: - boolean - 'null' x-go-name: UseOAuthForExchangeOnline useVmBiosUuid: description: 'Specifies if registered vCenter is using BIOS UUID to track virtual machines.' type: - boolean - 'null' x-go-name: UseVmBiosUuid username: description: Specifies username to access the target source. type: - string - 'null' x-go-name: Username vlanParams: description: 'Specifies the VLAN parameters to be used for performing the backup/restore of this entity.' $ref: '#/components/schemas/VlanParameters' warningMessages: description: 'Specifies a list of warnings encountered during registration. Though the registration may succeed, warning messages imply the host environment requires some cleanup or fixing.' type: - array - 'null' items: type: string x-go-name: WarningMessages x-go-package: cohesity/iris/server/data/public NetworkMapping: description: 'Specifies the information needed when mapping the source networks to target networks during restore and clone actions.' type: object title: Network Mapping properties: disableNetwork: description: 'Specifies if the network should be disabled. On restore or clone of the VM, if the network should be kept in disabled state, set this flag to true. The mapped network is enabled by default.' type: - boolean - 'null' x-go-name: DisableNetwork preserveMacAddress: description: 'Specifies if the source mac address should be preserved after restore or clone. In case of collision of mac address on target network the job won''t fail. Address collision should be resolved manually.' type: - boolean - 'null' x-go-name: PreserveMacAddress sourceNetworkId: description: Specifies the id of the source network. type: - integer - 'null' format: int64 x-go-name: SourceNetworkId targetNetworkId: description: Specifies the id of target network. type: - integer - 'null' format: int64 x-go-name: TargetNetworkId x-go-package: cohesity/iris/server/data/public ComparedADObject: description: 'Represents the details about an AD object and its properties. The attributes of the AD Object contain the information about whether they are equal on both Snapshot AD and Production AD as well as value of attribute on both Production and Snapshot AD.' type: object title: ComparedADObject properties: adAttributes: description: Specifies the list of AD attributes for the AD object. type: - array - 'null' items: $ref: '#/components/schemas/AdAttribute' x-go-name: AdAttributes adObjectFlags: description: 'Specifies the flags related to this AD Object. ''kEqual'' indicates all the attributes of the AD Object on the Snapshot and Production are equal. ''kNotEqual'' indicates atleast one of the attribute of the AD Object on the Snapshot and Production AD are not equal. ''kRestorePasswordRequired'' indicates the AD Object is of ''User'' object class type. when restoring this object from Snapshot AD to Priduction AD, a password is required. ''kMovedOnDestination'' indicates the object has moved to another container or OU in production AD compared to AD snapshot. In this case, the distinguishedName will be different for these objects ''kDestinationNotFound'' indicates the object corresponding to dest_guid specified is missing from Production AD. Caller should check this flag and empty ''dest_guid'' first to find out destination is missing. ''kDisableSupported'' indicates the enable and disable is supported on the AD Object. AD Objects of type ''User'' and ''Computers'' support this operation.' type: - array - 'null' items: type: string enum: - kEqual - kNotEqual - kRestorePasswordRequired - kMovedOnDestination - kDestinationNotFound - kDisableSupported x-go-name: AdObjectFlags destinationGuid: description: 'Specifies the guid of the object in the Production AD which is equivalent to the one in the Snapshot AD.' type: - string - 'null' x-go-name: DestinationGuid errorMessage: description: Specifies the error message while fetching the AD object. type: - string - 'null' x-go-name: ErrorMessage mismatchAttrCount: description: 'Specifies the number of attributes of AD Object mismatched on the Snapshot and Production AD.' type: - integer - 'null' format: uint32 x-go-name: MismatchAttrCount sourceGuid: description: Specifies the guid of the AD object in the Snapshot AD. type: - string - 'null' x-go-name: SourceGuid x-go-package: cohesity/iris/server/data/public IsilonNfsMountPoint: description: Specifies NFS Mount Point exposed by Isilon Protection Source. type: object title: Isilon NFS Mount Point. properties: accessZoneName: description: Specifies the Access Zone name. type: - string - 'null' x-go-name: AccessZoneName description: description: Specifies the description of the NFS mount point. type: - string - 'null' x-go-name: Description id: description: Specifies the Id of the NFS export. type: - integer - 'null' format: int64 x-go-name: Id x-go-package: cohesity/iris/server/data/public VirtualDiskRestoreResponse: description: 'Specifies the parameters to recover virtual disks of a vm with full Protection Source.' type: object title: Virtual Disk Restore Response. properties: powerOffVmBeforeRecovery: description: Specifies whether to power off the VM before recovering virtual disks. type: - boolean - 'null' x-go-name: PowerOffVmBeforeRecovery powerOnVmAfterRecovery: description: Specifies whether to power on the VM after recovering virtual disks. type: - boolean - 'null' x-go-name: PowerOnVmAfterRecovery targetSource: description: Specifies the target entity to which the disks should be attached. $ref: '#/components/schemas/ProtectionSource' virtualDiskMappings: description: Specifies the list of virtual disks mappings. type: - array - 'null' items: $ref: '#/components/schemas/VirtualDiskMappingResponse' x-go-name: VirtualDiskMappings x-go-package: cohesity/iris/server/data/public FlashBladeStorageArray: description: Specifies information about a Pure Storage FlashBlade Array. type: object title: Flash Blade Storage Array. properties: capacityBytes: description: 'Specifies the total capacity in bytes of the Pure Storage FlashBlade Array.' type: - integer - 'null' format: int64 x-go-name: CapacityBytes id: description: 'Specifies a unique id of a Pure Storage FlashBlade Array. The id is unique across Cohesity Clusters.' type: - string - 'null' x-go-name: Id networks: description: Specifies the network interfaces of the Pure Storage FlashBlade Array. type: - array - 'null' items: $ref: '#/components/schemas/FlashBladeNetworkInterface' x-go-name: Networks physicalUsedBytes: description: Specifies the space used for physical data in bytes. type: - integer - 'null' format: int64 x-go-name: PhysicalUsedBytes revision: description: Specifies the revision of the Pure Storage FlashBlade software. type: - string - 'null' x-go-name: Revision version: description: 'Specifies the software version running on the Pure Storage FlashBlade Array.' type: - string - 'null' x-go-name: Version x-go-package: cohesity/iris/server/data/public SiteDriveInfo: description: Specifies the Site's Document Library drive info. type: object title: Site Drive Info. properties: driveId: description: Specifies the Id of the Drive. type: - string - 'null' x-go-name: DriveId driveItemList: description: Specifies the Drive items such as files/folders. type: - array - 'null' items: $ref: '#/components/schemas/SiteDriveItem' x-go-name: DriveItemList driveName: description: 'Specifies the drive name for the document repsitory. Incase of drive Id not present, this field must be populated to trigger restore.' type: - string - 'null' x-go-name: DriveName restoreEntireDrive: description: 'Specifies whether entire drive is to be restored. This should be set to false if specific drive items are to be restored within ''DriveItemList''.' type: - boolean - 'null' x-go-name: RestoreEntireDrive x-go-package: cohesity/iris/server/data/public VmDirectoryListResult: description: 'VmDirectoryListResult is a struct containing information about each directory entry.' type: object title: VM Directory List Result. properties: cookie: description: 'Cookie is used for paginating results. If ReadVMDirResult is returning partial results, this field will be set. Supplying this cookie will resume listing from where this result left off.' type: - string - 'null' x-go-name: Cookie entries: description: 'Entries is the array of files and folders that are immediate children of the parent directory specified in the request.' type: - array - 'null' items: $ref: '#/components/schemas/VmDirEntry' x-go-name: Entries x-go-package: cohesity/iris/server/data/public HiveTable: description: Specifies an Object containing information about a Hive table. type: object title: Hive Table Info. properties: approxSizeBytes: description: Specifies the approx size of the table in bytes. type: - integer - 'null' format: int64 x-go-name: ApproxSizeBytes createdOn: description: Specifies the created on, epoch millis. type: - integer - 'null' format: int64 x-go-name: CreatedOn isTransactionalTable: description: Specifies if this is a transactional table. type: - boolean - 'null' x-go-name: IsTransactionalTable owner: description: Specifies the owner of the table. type: - string - 'null' x-go-name: Owner tableType: description: 'Specifies the type of table ex. MANAGED,VIRTUAL etc. Specifies the type of an Hive table. ''kManaged'' indicates a MANAGED Hive table. ''kExternal'' indicates a EXTERNAL Hive table. ''kVirtual'' indicates a VIRTUAL Hive tablet. ''kIndex'' indicates a INDEX Hive table.' type: - string - 'null' enum: - kManaged - kExternal - kVirtual - kIndex x-go-name: TableType x-go-package: cohesity/iris/server/data/public AdProtectionSource: description: Specifies an object representing an AD entity. type: object title: AD Protection Source. properties: domainController: description: Specifies the domain controller residing in this physical machine. $ref: '#/components/schemas/AdDomainController' domainName: description: Specifies the domain name corresponding to the domain controller. type: - string - 'null' x-go-name: DomainName name: description: Specifies the domain name of the AD entity. type: - string - 'null' x-go-name: Name ownerId: description: Specifies the entity id of the owner entity. type: - integer - 'null' format: int64 x-go-name: OwnerId type: description: 'Specifies the type of the managed object in AD Protection Source. Specifies the kind of AD protection source. ''kRootContainer'' indicates the entity is a root container to an AD domain controller. ''kDomainController'' indicates the domain controller hosted in this physical server.' type: - string - 'null' enum: - kRootContainer - kDomainController x-go-name: Type uuid: description: Specifies the UUID for the AD entity. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public DiskBlock: description: 'Specifies a contiguous block by defining an offset and length of the block.' type: object title: Disk Block. properties: lengthBytes: description: Specifies the length of the block in bytes. type: - integer - 'null' format: int64 x-go-name: LengthBytes offsetBytes: description: 'Specifies the offset of the block (in bytes) from the beginning of the containing object such as a physical disk or a virtual disk file.' type: - integer - 'null' format: int64 x-go-name: OffsetBytes x-go-package: cohesity/iris/server/data/public RestorePointsForTimeRange: description: Specifies the info returned by Magneto RestorePointsForTimeRange API. type: object title: Restore Points for Time Range. properties: fullSnapshotInfo: description: Specifies the info related to the recovery object. type: - array - 'null' items: $ref: '#/components/schemas/FullSnapshotInfo' x-go-name: FullSnapshotInfo timeRanges: description: Specifies the time ranges of the restore object between full snapshots. type: - array - 'null' items: $ref: '#/components/schemas/TimeRangeSettings' x-go-name: TimeRanges x-go-package: cohesity/iris/server/data/public MountVolumesState: description: 'Specifies the states of mounting all the volumes onto a mount target for a ''kRecoverVMs'' Restore Task.' type: object title: Mount Volumes States. properties: bringDisksOnline: description: 'Optional setting that determines if the volumes are brought online on the mount target after attaching the disks. This option is only significant for VMs.' type: - boolean - 'null' x-go-name: BringDisksOnline mountVolumeResults: description: 'Array of Mount Volume Results. Specifies the results of mounting each specified volume.' type: - array - 'null' items: $ref: '#/components/schemas/MountVolumeResultDetails' x-go-name: MountVolumeResults otherError: description: Specifies an error that did not occur during the mount operation. title: Non-mount Error. allOf: - $ref: '#/components/schemas/RequestError' targetSourceId: description: 'Specifies the target Protection Source Id where the volumes will be mounted. NOTE: The source that was backed up and the mount target must be the same type, for example if the source is a VMware VM, then the mount target must also be a VMware VM. The mount target must be registered on the Cohesity Cluster.' type: - integer - 'null' format: int64 x-go-name: TargetSourceId username: description: Specifies the username to access the mount target. type: - string - 'null' x-go-name: Username x-go-package: cohesity/iris/server/data/public MongoDBCollection: description: Specifies an Object containing information about a mongodb collection. type: object title: MongoDB Collection Info. properties: isCappedCollection: description: Set to true if this is a capped Collection. type: - boolean - 'null' x-go-name: IsCappedCollection isMongoView: description: Set to true if this Collection is a view. type: - boolean - 'null' x-go-name: IsMongoView sizeBytes: description: Size of this Collection. type: - integer - 'null' format: int64 x-go-name: SizeBytes x-go-package: cohesity/iris/server/data/public KvmProtectionSource: description: Specifies a Protection Source in KVM environment. type: object title: KVM Protection Source. properties: agentError: description: Specifies a message when the agent cannot be reached. type: - string - 'null' x-go-name: AgentError agentId: description: 'Specifies the ID of the Agent with which this KVM entity is associated when the entity represents a Delegate host or KVM host.' type: - integer - 'null' format: int64 x-go-name: AgentId clusterId: description: Specifies the cluster ID for 'kCluster' objects. type: - string - 'null' x-go-name: ClusterId datacenterId: description: Specifies the ID of the 'kDatacenter' objects. type: - string - 'null' x-go-name: DatacenterId description: description: Specifies a description about the Protection Source. type: - string - 'null' x-go-name: Description name: description: Specifies the name of the KVM entity. type: - string - 'null' x-go-name: Name networkId: description: Specifies the network ID to which Vnic is attached. type: - string - 'null' x-go-name: NetworkId type: description: 'Specifies the type of KVM Protection Source entities such as ''kDatacenter'', ''kCluster'', ''kVirtualMachine'', etc. Specifies the type of an KVM source entity. ''kOVirtManager'' indicates the root entity registered with Cohesity cluster. ''kStandaloneHost'' indicates a host registered with Cohesity cluster. ''kDatacenter'' indicates a KVM datacenter managed by the OVirt manager. ''kCluster'' indicates a KVM cluster managed by the OVirt manager. ''kHost'' indicates a host within the KVM environment. ''kVirtualMachine'' indicates a virtual machine in the KVM enironment. ''kNetwork'' represents a network used by the virtual machine entity. ''kStorageDomain'' represents a storage domain in the KVM environment. ''kVNicProfile'' represents a VNic profile.' type: - string - 'null' enum: - kOVirtManager - kStandaloneHost - kDatacenter - kCluster - kHost - kVirtualMachine - kNetwork - kStorageDomain - kVNicProfile x-go-name: Type uuid: description: 'Specifies the UUID of the Object. This is unique within the KVM environment.' type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public FleetTag: description: Specfies the key,value pair for the fleet tag. type: object title: Fleet Tag Parameters. properties: key: description: Specifies the key for the fleet tag. type: - string - 'null' x-go-name: Key value: description: Specifies the value for the fleet tag. type: - string - 'null' x-go-name: Value x-go-package: cohesity/iris/server/data/public IscsiSanPort: description: Specifies an iSCSI SAN Port. type: object title: ISCSI SAN Port. properties: ipAddress: description: Specifies the IP address of the SAN port. type: - string - 'null' x-go-name: IpAddress iqn: description: Specifies the qualified name of the iSCSI port (IQN). type: - string - 'null' x-go-name: Iqn tcpPort: description: Specifies the listening port(tcp) of the SAN port. type: - integer - 'null' format: int32 x-go-name: TcpPort x-go-package: cohesity/iris/server/data/public CompareAdObjectsRequest: description: Specifies the request to compare AD objects from Snapshot and Production AD. type: object title: Compare AD Objects Request. required: - RestoreTaskId - guidPairs properties: RestoreTaskId: description: 'Specifies the Restore Task Id corresponding to which we need to compare the AD objects.' type: - integer - 'null' format: int64 allowEmptyDestGuids: description: 'Specifies the option to get object attributes from Snapshot AD when destination guid is missing in GuidPair. This helps to show attributes of AD object from Snapshot AD when the object is missing in Production AD.' type: - boolean - 'null' x-go-name: AllowEmptyDestGuids excludeSysAttributes: description: 'Specifies the option to exclude AD system attributes when comparing two AD object attributes. If the objects have same guid, most of the system attributes would match.If the AD object was recovered through a restore, then many system attributes will be different. Default compares all attributes.' type: - boolean - 'null' x-go-name: ExcludeSysAttributes filterNullValueAttributes: description: 'Specifies the option to not return attributes where source and destination values are null values. This reduces noise of the properties in the objects returned.' type: - boolean - 'null' x-go-name: FilterNullValueAttributes filterSameValueAttributes: description: 'Specifies the option to not return attributes where source and destination values are same. Use this flag to return only values that are different.' type: - boolean - 'null' x-go-name: FilterSameValueAttributes guidPairs: description: 'Specifies the GuidPair of the AD Objects which we want to compare from both Snapshot and Production AD.' type: - array - 'null' items: $ref: '#/components/schemas/GuidPair' x-go-name: GuidPairs quickCompare: description: 'Specifies the option to do quick compare of specified guid between Snapshot AD and Production AD. If at least one attribute mismatch is found, comparison stops and returns with AdObjectFlag kNotEqual.' type: - boolean - 'null' x-go-name: QuickCompare x-go-package: cohesity/iris/server/data/public IpDetails: description: 'Entity Type | IP Address Details | Details field kHostSystem | VMKernel Adapter IP Addresses | VMKernelAdapter TODO(Matthew) : Use an enum for the ''Details''.' type: object title: 'IP address details The table below captures the type if information published by an entity type using this field.' properties: details: description: Details of the IP Addresses captured below type: - string - 'null' x-go-name: Details ipAddresses: description: The IP Addresses type: - array - 'null' items: type: string x-go-name: IpAddresses x-go-package: cohesity/iris/server/data/public ElastifileContainer: description: Specifies information about container in an Elastifile Cluster. type: object title: Elastifile Container. properties: createdAt: description: Specifies the creation date of the container. type: - string - 'null' x-go-name: CreatedAt id: description: Specifies id of a Elastifile Container in a Cluster. type: - integer - 'null' format: int32 x-go-name: Id isNfsInterface: description: Specifies if the container has NFS volumes or not. type: - boolean - 'null' x-go-name: IsNfsInterface isSmbInterface: description: Specifies if the container has SMB volumes or not. type: - boolean - 'null' x-go-name: IsSmbInterface name: description: Specifies the name of the container. type: - string - 'null' x-go-name: Name protocols: description: 'Specifies Elastifile supported Protocol information enabled on Elastifile container. ''kNfs'' indicates NFS protocol in an elastifile container. ''kSmb'' indicates SMB protocol in an elastifile container.' type: - array - 'null' items: type: string enum: - kNfs - kSmb x-go-name: Protocols usedBytes: description: Specifies the bytes used by the container. type: - integer - 'null' format: int64 x-go-name: UsedBytes uuid: description: Specifies the UUID of the container. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public AcropolisRestoreParameters: description: 'This field defines the Acropolis specific params for restore tasks of type kRecoverVMs.' type: object properties: disableNetwork: description: 'Specifies whether the network should be left in disabled state. Attached network is enabled by default. Set this flag to true to disable it.' type: - boolean - 'null' x-go-name: DisableNetwork networkId: description: 'Specifies a network configuration to be attached to the cloned or recovered object. For kCloneVMs and kRecoverVMs tasks, original network configuration is detached if the cloned or recovered object is kept under a different parent Protection Source or a different Resource Pool. By default, for kRecoverVMs task, original network configuration is preserved if the recovered object is kept under the same parent Protection Source and the same Resource Pool. Specify this field to override the preserved network configuration or to attach a new network configuration to the cloned or recovered objects. You can get the networkId of the kNetwork object by setting includeNetworks to ''true'' in the GET /public/protectionSources operation. In the response, get the id of the desired kNetwork object, the resource pool, and the registered parent Protection Source.' type: - integer - 'null' format: int64 x-go-name: NetworkId poweredOn: description: 'Specifies the power state of the cloned or recovered objects. By default, the cloned or recovered objects are powered off.' type: - boolean - 'null' x-go-name: KeepPoweredOn prefix: description: 'Specifies a prefix to prepended to the source object name to derive a new name for the recovered or cloned object. By default, cloned or recovered objects retain their original name. Length of this field is limited to 8 characters.' type: - string - 'null' x-go-name: Prefix storageContainerId: 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.' type: - integer - 'null' format: int64 x-go-name: StorageContainerId suffix: description: 'Specifies a suffix to appended to the original source object name to derive a new name for the recovered or cloned object. By default, cloned or recovered objects retain their original name. Length of this field is limited to 8 characters.' type: - string - 'null' x-go-name: Suffix x-go-package: cohesity/iris/server/data/public ElastifileCluster: description: Specifies information about a Elastifile Cluster. type: object title: Elastifile Cluster. properties: enodeIpAddressVec: description: IP addresses of Elastifile nodes. type: - array - 'null' items: type: string x-go-name: ElastifileNodeIps loadBalancerVip: description: Specifies the load balancer VIP if present. type: - string - 'null' x-go-name: LoadBalancerVip name: description: Specifies name of a Elastifile Cluster type: - string - 'null' x-go-name: Name uuid: description: Specifies the UUID of a Elastifile Cluster. type: - string - 'null' x-go-name: Uuid version: description: Specifies the version of a Elastifile Cluster. type: - string - 'null' x-go-name: Version x-go-package: cohesity/iris/server/data/public VirtualDiskIdInformation: description: 'Specifies information about virtual disk which includes disk uuid, controller type, bus number and unit number.' type: object title: Virtual Disk Id. properties: busNumber: description: Specifies the Id of the controller bus that controls the disk. type: - integer - 'null' format: int64 x-go-name: BusNumber controllerType: description: Specifies the controller type like SCSI, or IDE etc. type: - string - 'null' x-go-name: ControllerType diskId: description: Specifies the uuid of the virtual disk. type: - string - 'null' x-go-name: DiskId unitNumber: description: 'Specifies the disk file name. This is the VMDK name and not the flat file name.' type: - integer - 'null' format: int64 x-go-name: UnitNumber x-go-package: cohesity/iris/server/data/public GpfsProtectionSource: description: Specifies a Protection Source in GPFS environment. type: object title: GPFS Protection Source. properties: cluster: description: 'Specifies information of an GPFS Cluster. This is set only when the entity type is ''kCluster''.' $ref: '#/components/schemas/GpfsCluster' fileset: description: 'Specifies information about a mount point in an GPFS file system. This is set only when the entity type is ''kFileset''.' $ref: '#/components/schemas/GpfsFileset' filesystem: description: 'Specifies an access zone in an GPFS file system. This is set only when the entity type is ''kFilesystem''.' $ref: '#/components/schemas/GpfsFilesystem' name: description: Specifies a unique name of the Protection Source. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of the entity in an GPFS file system like ''kCluster'', ''kFilesystem'', or, ''kFileset''. ''kCluster'' indicates an GPFS Cluster. ''kFilesystem'' indicates a top level filesystem on GPFS cluster. ''kFileset'' indicates a fileset within a filesystem.' type: - string - 'null' enum: - kCluster - kFilesystem - kFileset x-go-name: Type x-go-package: cohesity/iris/server/data/public ObjectSearchResults: description: 'Specifies an array of backup objects and a count to indicate if additional requests must be made to get the full result.' type: object title: Object Search Results. properties: objectSnapshotInfo: description: 'Array of Snapshot Objects. Specifies the list of backup objects returned by this request that match the specified search and filter criteria. The number of objects returned is limited by the pageCount field.' type: - array - 'null' items: $ref: '#/components/schemas/ObjectSnapshotInfo' x-go-name: ObjectSnapshotInfo totalCount: description: 'Specifies the total number of backup objects that match the filter and search criteria. Use this value to determine how many additional requests are required to get the full result.' type: - integer - 'null' format: int64 x-go-name: TotalCount x-go-package: cohesity/iris/server/data/public CassandraKeyspace: description: Specifies an Object containing information about a Cassandra Keyspace. type: object title: Cassandra Keyspace Info. properties: childrenCount: description: Number of documents in this bucket. type: - integer - 'null' format: uint32 x-go-name: ChildrenCount dcList: description: 'If the replication strategy is set as kNetwork, then dc_list will have a list of data centers to which the keyspace is being replicated to.' type: - array - 'null' items: type: string x-go-name: DcList replicationStrategy: description: 'Replication stragegy for the keyspace. Specifies the type of an Cassandra source entity.' type: - string - 'null' enum: - kSimple - kNetwork - kUnsupported x-go-name: ReplicationStrategy x-go-package: cohesity/iris/server/data/public OutlookMailbox: description: 'Specifies the Outlook mailbox with restore details to support full or partial recovery.' type: object title: Outlook Mailbox. properties: mailboxObject: description: Specifies the details of the mailbox object. $ref: '#/components/schemas/RestoreObjectDetails' outlookFolderList: description: 'Specifies the list of folders to be restored incase user wishes not to restore entire mailbox.' type: - array - 'null' items: $ref: '#/components/schemas/OutlookFolder' x-go-name: OutlookFolderList restoreEntireMailbox: description: Specifies whether the entire mailbox is to be restored. type: - boolean - 'null' x-go-name: RestoreEntireMailbox x-go-package: cohesity/iris/server/data/public SiteOwner: description: Specifies the details about a SharePoint Site owner. type: object title: Site Owner. properties: driveInfoList: description: Specifies the Document Libraries within a Site which are to be restored. type: - array - 'null' items: $ref: '#/components/schemas/SiteDriveInfo' x-go-name: DriveInfoList siteDetailObject: description: Specifies the details about the SharePoint Site to which drives belong. $ref: '#/components/schemas/RestoreObjectDetails' x-go-package: cohesity/iris/server/data/public 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 PureProtectionSource: description: Specifies a Protection Source in a Pure environment. type: object title: Pure Protection Source. properties: name: description: Specifies a unique name of the Protection Source type: - string - 'null' x-go-name: Name storageArray: description: 'Specifies a SAN Storage Array information. This is set only when the type is kStorageArray.' $ref: '#/components/schemas/SanStorageArray' type: description: 'Specifies the type of managed Object in a SAN/Pure Protection Source like a kStorageArray or kVolume. Examples of SAN Objects include ''kStorageArray'' and ''kVolume''. ''kStorageArray'' indicates that entire SAN storage array is being protected. ''kVolume'' indicates that volume within the array is being protected.' type: - string - 'null' enum: - kStorageArray - kVolume x-go-name: Type volume: description: 'Specifies a SAN Volume information within a storage array. This is set only when the type is kVolume.' $ref: '#/components/schemas/SanVolume' x-go-package: cohesity/iris/server/data/public 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 Office365ProtectionSource: description: Specifies a Protection Source in Office 365 environment. type: object title: Office 365 Protection Source. properties: description: description: Specifies the description of the Office 365 entity. type: - string - 'null' x-go-name: Description name: description: Specifies the name of the office 365 entity. type: - string - 'null' x-go-name: Name primarySMTPAddress: description: Specifies the SMTP address for the Outlook source. type: - string - 'null' x-go-name: PrimarySMTPAddress type: description: 'Specifies the type of the Office 365 entity. Specifies the type of Office 365 entity ''kDomain'' indicates the O365 domain through which authentication occurs. ''kOutlook'' indicates the Exchange online entities. ''kMailbox'' indicates the user''s mailbox account. ''kUsers'' indicates the container for User entities. ''kGroups'' indicates the container for Group entities. ''kSites'' indicates the container for Site entities. ''kUser'' indicates an Office365 User entity. ''kGroup'' indicates an Office365 Group entity. ''kSite'' indicates an Office365 SharePoint Site entity.' type: - string - 'null' enum: - kDomain - kOutlook - kMailbox - kUsers - kGroups - kSites - kUser - kGroup - kSite x-go-name: Type userInfo: description: 'Specifies the information about Office365 user regarding its Mailbox & OneDrive. This is only present if the entity type is a User.' $ref: '#/components/schemas/Office365UserInfo' uuid: description: Specifies the UUID of the Office 365 entity. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public DeployVmsToCloud: description: 'Specifies the details about deploying vms to specific clouds where backup may be stored and converted.' type: object title: DeployVmsToCloud Parameters. 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' fleetParams: description: Specifies various resources when deploying vms to fleet instances. $ref: '#/components/schemas/FleetParams' x-go-package: cohesity/iris/server/data/public FilesystemVolume: description: Specifies information about a filesystem volume. type: object title: Filesystem Volume. properties: disks: description: 'Array of Disks and Partitions. Specifies information about all the disks and partitions needed to mount this logical volume.' type: - array - 'null' items: $ref: '#/components/schemas/Disk' x-go-name: Disks displayName: description: Specifies a description about the filesystem. type: - string - 'null' x-go-name: DisplayName filesystemType: description: Specifies type of the filesystem on this volume. type: - string - 'null' x-go-name: FilesystemType filesystemUuid: description: Specifies the uuid of the filesystem. type: - string - 'null' x-go-name: FilesystemUuid isSupported: description: If true, this is a supported filesystem volume type. type: - boolean - 'null' x-go-name: IsSupported logicalVolume: description: 'Specify attributes for a kLMV (Linux) or kLDM (Windows) filesystem. This field is set only for kLVM and kLDM volume types.' title: Logical Volume. allOf: - $ref: '#/components/schemas/LogicalVolume' logicalVolumeType: description: 'Specifies the type of logical volume such as kSimpleVolume, kLVM or kLDM. ''kSimpleVolume'' indicates a simple volume. Data can be used by just mounting the only one partition present on the disk. ''kLVM'' indicates a logical volume on Linux managed by a Logical Volume Manager. In order to access the data, deviceTree must be created based on the specification in logicalVolume.deviceTree. ''kLDM'' indicates a logical volume on Windows managed by Logical Disk Manager.' type: - string - 'null' enum: - kSimpleVolume - kLVM - kLDM x-go-name: LogicalVolumeType name: description: Specifies the name of the volume such as /C. type: - string - 'null' x-go-name: Name volumeGuid: description: 'VolumeGuid is the Volume guid. This is populated for kPhysical environments.' type: - string - 'null' x-go-name: VolumeGuid x-go-package: cohesity/iris/server/data/public FlashBladeProtectionSource: description: Specifies a Protection Source in Pure Storage FlashBlade environment. type: object title: Pure Storage FlashBlade Protection Source. properties: fileSystem: description: 'Specifies a Pure Storage FlashBlade File System information. This is set only when the object type is ''kFileSystem''.' $ref: '#/components/schemas/FlashBladeFileSystem' name: description: Specifies a unique name of the Protection Source. type: - string - 'null' x-go-name: Name storageArray: description: 'Specifies a Pure Storage FlashBlade Array information. This is set only when the object type is ''kStorageArray''.' $ref: '#/components/schemas/FlashBladeStorageArray' type: description: 'Specifies the type of managed object in a Pure Storage FlashBlade like ''kStorageArray'' or ''kFileSystem''. ''kStorageArray'' indicates a top level Pure Storage FlashBlade array. ''kFileSystem'' indicates a Pure Storage FlashBlade file system within the array.' type: - string - 'null' enum: - kStorageArray - kFileSystem x-go-name: Type x-go-package: cohesity/iris/server/data/public OneDriveInfo: description: Specifies OneDrive details with the items which need to be restored. type: object title: OneDrive Information. properties: driveId: description: Specifies the Id of the Drive. type: - string - 'null' x-go-name: DriveId driveItemList: description: Specifies the Drive items such as files/folders. type: - array - 'null' items: $ref: '#/components/schemas/OneDriveItem' x-go-name: DriveItemList restoreEntireDrive: description: 'Specifies whether entire drive is to be restored. This should be set to false if specific drive items are to be restored within ''DriveItemList''.' type: - boolean - 'null' x-go-name: RestoreEntireDrive x-go-package: cohesity/iris/server/data/public 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 ExchangeDatabaseCopyInfo: description: 'Specifies the information about the copy of the Exchange Database on particular Exchange Application Server that is part of DAG.' type: object title: Exchange Database Copy Information properties: activationPreferenceNumber: description: 'Specifies the activation preference number assigned for this database copy.' type: - integer - 'null' format: uint32 x-go-name: ActivationPreferenceNumber appServerId: description: 'Specifies the entity id of the Exchange Application Server which has this database copy.' type: - integer - 'null' format: int64 x-go-name: AppServerId backupSupported: description: Specifies if backup is supported for the Exchange database copy. type: - boolean - 'null' x-go-name: BackupSupported backupUnsupportedReasons: description: Specifies any reason(s) for Exchange database backup not supported. type: - array - 'null' items: type: string x-go-name: BackupUnsupportedReasons copyGuid: description: Specifies the Guid of the Exchange Database Copy. type: - string - 'null' x-go-name: CopyGuid createdTimeMsecs: description: 'Specifies the time when the database is created in Unix epoch time in milliseconds.' type: - integer - 'null' format: int64 x-go-name: CreatedTimeMsecs databaseState: description: 'Specifies the state of the Exchange database copy. Specifies the state of Exchange Database Copy. ''kUnknown'' indicates the status is not known. ''kMounted'' indicates the exchange database copy is mounted and healthy. ''kError'' indicates the exchange database copy is unmounted or partially mounted or is in error state.' type: - string - 'null' enum: - kUnknown - kMounted - kError x-go-name: DatabaseState dbSizeBytes: description: Specifies the size of the Exchange database copy in bytes. type: - integer - 'null' format: int64 x-go-name: DbSizeBytes dbguid: description: Specifies the guid of the Exchange Database. type: - string - 'null' x-go-name: DbGuid fqdn: description: 'Specifies the fully qualified domain name of the Exchange Server on which the database copy is hosted.' type: - string - 'null' x-go-name: Fqdn isActiveCopy: description: 'Specifies if the Exchange database copy present on the Exchange Application server is active or passive.' type: - boolean - 'null' x-go-name: ActiveCopy name: description: Specifes the name of the Exchange Database. type: - string - 'null' x-go-name: Name ownerId: description: 'Specifies the owner entity id of the Exchange Application Server which has this database copy.' type: - integer - 'null' format: int64 x-go-name: OwnerId serverName: description: 'Specifies the display name of the Exchange Application Server on which the database copy is hosted.' type: - string - 'null' x-go-name: ServerName utcOffsetMin: description: Specifies UTC time offset of database creation time. type: - integer - 'null' format: int64 x-go-name: UtcOffsetMin x-go-package: cohesity/iris/server/data/public GpfsFilesystem: description: Specifies information about filesystem in a GPFS Cluster. type: object title: GPFS Filesystem. properties: id: description: Specifies the id of the file system. type: - string - 'null' x-go-name: Id path: description: Specifies the path of the file system. type: - string - 'null' x-go-name: Path x-go-package: cohesity/iris/server/data/public DownloadFilesAndFoldersParams: description: 'DownloadFilesAndFoldersParams holds the information to create a task for downloading list of files or folders' type: object title: Download Files And Folders Parameters. required: - name properties: filesAndFoldersInfo: description: Specifies the absolute paths for list of files and folders to download. type: - array - 'null' items: $ref: '#/components/schemas/FilesAndFoldersInfo' x-go-name: FilesAndFoldersInfo name: description: 'Specifies the name of the Download Task. This field must be set and must be a unique name.' type: - string - 'null' x-go-name: Name sourceObjectInfo: description: 'Specifies the details of the task that is created in order to download the specified list of files and folders.' $ref: '#/components/schemas/RestoreObjectDetails' x-go-package: cohesity/iris/server/data/public Office365Credentials: description: Specifies the credentials to authenticate with Office365 account. type: object title: Office365 Credentials. properties: clientId: description: 'Specifies the application ID that the registration portal (apps.dev.microsoft.com) assigned.' type: - string - 'null' x-go-name: ClientId clientSecret: description: 'Specifies the application secret that was created in app registration portal.' type: - string - 'null' x-go-name: ClientSecret grantType: description: 'Specifies the application grant type. eg: For client credentials flow, set this to "client_credentials"; For refreshing access-token, set this to "refresh_token".' type: - string - 'null' x-go-name: GrantType scope: description: 'Specifies a space separated list of scopes/permissions for the user. eg: Incase of MS Graph APIs for Office365, scope is set to default: https://graph.microsoft.com/.default' type: - string - 'null' x-go-name: Scope useOAuthForExchangeOnline: description: 'This field is deprecated from here and placed in RegisteredSourceInfo and ProtectionSourceParameters. deprecated: true' type: - boolean - 'null' x-go-name: UseOAuthForExchangeOnline x-go-package: cohesity/iris/server/data/public NimbleProtectionSource: description: Specifies a Protection Source in a Nimble environment. type: object title: Nimble Protection Source. properties: name: description: Specifies a unique name of the Protection Source type: - string - 'null' x-go-name: Name storageArray: description: 'Specifies a SAN Storage Array information. This is set only when the type is kStorageArray.' $ref: '#/components/schemas/SanStorageArray' type: description: 'Specifies the type of managed Object in a SAN/Nimble Protection Source like a kStorageArray or kVolume. Examples of SAN Objects include ''kStorageArray'' and ''kVolume''. ''kStorageArray'' indicates that entire SAN storage array is being protected. ''kVolume'' indicates that volume within the array is being protected.' type: - string - 'null' enum: - kStorageArray - kVolume x-go-name: Type volume: description: 'Specifies a SAN Volume information within a storage array. This is set only when the type is kVolume.' $ref: '#/components/schemas/SanVolume' x-go-package: cohesity/iris/server/data/public HdfsProtectionSource: description: Specifies an Object representing Hdfs. type: object title: Hdfs Protection Source. properties: name: description: Specifies the instance name of the Hdfs entity. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of the managed Object in Hdfs Protection Source. Specifies the type of an Hdfs source entity. ''kCluster'' indicates a Hdfs cluster distributed over several physical nodes.' type: - string - 'null' enum: - kCluster x-go-name: Type uuid: description: Specifies the UUID for the Hdfs entity. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public FlashBladeNetworkInterface: description: Specifies network interface detail of a Flash Blade Storage Array. type: object title: Flash Blade Network Interface. properties: ipAddress: description: Specifies the IP address of the Pure Storage FlashBlade Array. type: - string - 'null' x-go-name: IpAddress name: description: Specifies the name of the network interface. type: - string - 'null' x-go-name: Name vlan: description: Specifies the id of the VLAN network of the Pure Storage FlashBlade Array. type: - integer - 'null' format: int32 x-go-name: Vlan x-go-package: cohesity/iris/server/data/public VcdStorageProfile: description: Specifies a storage profile for use while recovering to a VMware VCD. type: object title: Vcd Storage Profile. properties: name: description: Specifies the name of the storage profile. type: - string - 'null' x-go-name: Name uuid: description: Specifies the UUID of the storage profile as identified by the VCD. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public GuidPair: description: Represents the guid pair of an AD Object. type: object title: GuidPair properties: destGuid: description: Specifies the guid of an AD object in the Production AD. type: - string - 'null' x-go-name: DestGuid sourceGuid: description: Specifies the guid of an AD object in the Snapshot AD. type: - string - 'null' x-go-name: SourceGuid x-go-package: cohesity/iris/server/data/public AttributeRestoreInformation: description: Represents the details about the restore of the AD attribute. type: object title: Attribute Restore Information. properties: errorMessage: description: Specifes the error messages corresponding to restore of the attribute. type: - array - 'null' items: type: string x-go-name: ErrorMessage name: description: Specifies the name of the attribute of the AD object. type: - string - 'null' x-go-name: Name x-go-package: cohesity/iris/server/data/public ExchangeRestoreParameters: description: Specifies the exchange restore parameters. type: object title: Exchange Application Server Restore Parameters. properties: type: description: 'Specifies the Exchange restore type. Specifies the type of Exchange restore. ''kNone'' specifies no special behaviour. ''kView'' specifies the option to create a view which cann be used by the external tools like Kroll to perform mailbox or mail-item recovery. ''kDatabase'' specifies the option to restore an Exchange database.' type: - string - 'null' enum: - kNone - kView - kDatabase x-go-name: Type viewParameters: description: Specifies the paramters for the restore of type kView. $ref: '#/components/schemas/ExchangeRestoreViewParameters' x-go-package: cohesity/iris/server/data/public ExchangeProtectionSource: description: 'Specifies an object representing an Exchange entity. DAG - Database availability group' type: object title: Exchange Protection Source. properties: DagInfo: description: 'Specifies the Exchange DAG information if ExchangeProtectionSourceType is ''kExchangeDAG''.' $ref: '#/components/schemas/DagInfo' applicationServerInfo: description: 'Specifies the Exchange Application server information if ExchangeProtectionSourceType is ''kExchangeNode''.' $ref: '#/components/schemas/ApplicationServerInfo' dagDatabaseCopyInfo: description: 'Specifies the Exchange DAG Database copy information if ExchangeProtectionSourceType is ''kExchangeDAGDatabaseCopy''.' $ref: '#/components/schemas/ExchangeDatabaseCopyInfo' dagDatabaseInfo: description: 'Specifies the Exchange DAG Database information if ExchangeProtectionSourceType is ''kExchangeDAGDatabase''' $ref: '#/components/schemas/ExchangeDAGDatabase' name: type: - string - 'null' x-go-name: Name ownerId: description: Specifies the entity id of the owner of the Exchange Protection Source. type: - integer - 'null' format: int64 x-go-name: OwnerId standaloneDatabaseCopyInfo: description: 'Specifies the Exchange Standalone Database information if ExchangeProtectionSourceType is ''kExchangeStandaloneDatabase''.' $ref: '#/components/schemas/ExchangeDatabaseInfo' type: description: Specifies the type of the Exchange Protection Source. type: - integer - 'null' format: int32 x-go-name: Type uuid: description: Specifies the UUID for the Exchange entity. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public ReplicaInfo: description: Specifies the Replication information about a snapshot. type: object title: Replica Info. properties: expiryTimeUsecs: description: Specifies the expiration time of the snapshot within the target location. type: - integer - 'null' format: int64 x-go-name: ExpiryTimeUsecs snapshotTargetSettings: description: Specifies the snapshot target settings for the given snapshot. $ref: '#/components/schemas/SnapshotTargetSettings' uid: description: 'Specifies a global Protection Job id that is unique across Cohesity Clusters.' $ref: '#/components/schemas/UniversalId' x-go-package: cohesity/iris/server/data/public AdRestoreParameters: description: Specifies the parameters specific to Application domain controller. type: object title: AD Application Server Restore Parameters. properties: adOptions: description: Specifies the Active Directory options for the Restore task. $ref: '#/components/schemas/AdRestoreOptions' credentials: description: Specifies the credentials which are needed to connect to Production AD. $ref: '#/components/schemas/Credentials' mountAndRestore: description: 'Specifies the option to mount the AD snapshot database and restore the AD objects in a single restore task. AdOptions must be set if this is set to true.' type: - boolean - 'null' x-go-name: MountAndRestore port: description: 'Specifies the port on which the AD domain controller''s NTDS database will be mounted.' type: - integer - 'null' format: int32 x-go-name: Port x-go-package: cohesity/iris/server/data/public QuotaPolicy: description: 'Specifies a quota limit that can be optionally applied to Views and View Boxes. At the View level, this quota defines a logical limit for usage on the View. At the View Box level, this quota defines a physical limit or a default logical View limit. If a physical quota is specified for View Box, this quota defines a physical limit for the usage on the View Box. If a default logical View quota is specified for View Box, this limit is inherited by all the Views in that View Box. However, this inherited quota can be overwritten at the View level. A new write is not allowed if the resource will exceed the specified quota. However, it takes time for the Cohesity Cluster to calculate the usage across Nodes, so the limit may be exceeded by a small amount. In addition, if the limit is increased or data is removed, there may be a delay before the Cohesity Cluster allows more data to be written to the resource, as the Cluster calculates the usage across Nodes.' type: object title: Quota Policy properties: alertLimitBytes: description: 'Specifies if an alert should be triggered when the usage of this resource exceeds this quota limit. This limit is optional and is specified in bytes. If no value is specified, there is no limit.' type: - integer - 'null' format: int64 x-go-name: AlertLimitBytes alertThresholdPercentage: description: 'Supported only for user quota policy. Specifies when the usage goes above an alert threshold percentage which is: HardLimitBytes * AlertThresholdPercentage, eg: 80% of HardLimitBytes Can only be set if HardLimitBytes is set. Cannot be set if AlertLimitBytes is already set.' type: - integer - 'null' format: int64 x-go-name: AlertThresholdPercentage hardLimitBytes: description: 'Specifies an optional quota limit on the usage allowed for this resource. This limit is specified in bytes. If no value is specified, there is no limit.' type: - integer - 'null' format: int64 x-go-name: HardLimitBytes x-go-package: cohesity/iris/server/data/public OracleProtectionSource: description: Specifies an Object representing one Oracle database. type: object title: Oracle Protection Source. properties: archiveLogEnabled: description: 'Specifies whether the database is running in ARCHIVELOG mode. It enables the redo of log files into archived redo log files.' type: - boolean - 'null' x-go-name: ArchiveLogEnabled bctEnabled: description: 'Specifies whether the Block Change Tracking is enabled. BCT improves the performance of incremental backups by recording changed blocks into the block change tracking file. RMAN then uses this file to identify changed blocks to be backed up.' type: - boolean - 'null' x-go-name: BCTEnabled containerDatabaseInfo: description: 'Specifies the Container Database Information including the Pluggable databases within the container.' $ref: '#/components/schemas/OracleContainerDatabaseInfo' dataGuardInfo: description: 'Specifies the Data Gurad configuration information for the current DB entity.' $ref: '#/components/schemas/OracleDataGuardInfo' databaseUniqueName: description: Specifies the unique name of the Oracle entity. type: - string - 'null' x-go-name: DatabaseUniqueName dbType: description: 'Specifies the type of the database in Oracle Protection Source. ''kRACDatabase'' indicates the database is a RAC DB. ''kSingleInstance'' indicates that the database is single instance.' type: - string - 'null' enum: - kSingleInstance - kRACDatabase x-go-name: DbType domain: description: Specifies the Oracle DB Domain. type: - string - 'null' x-go-name: Domain fraSize: description: Specifies Flash/Fast Recovery area size for the current DB entity. type: - integer - 'null' format: int64 x-go-name: FraSize hosts: description: Specifies the list of hosts for the current DB entity. type: - array - 'null' items: $ref: '#/components/schemas/OracleHost' x-go-name: Hosts name: description: Specifies the instance name of the Oracle entity. type: - string - 'null' x-go-name: Name ownerId: description: 'Specifies the entity id of the owner entity (such as a VM). This is only set if type is kDatabase.' type: - integer - 'null' format: int64 x-go-name: OwnerId sgaTargetSize: description: 'Specifies System Global Area size for the current DB entity. A system global area (SGA) is a group of shared memory structures that contain data and control information for one Oracle database.' type: - string - 'null' x-go-name: SgaTargetSize sharedPoolSize: description: Specifies Shared Pool Size for the current DB entity. type: - string - 'null' x-go-name: SharedPoolSize size: description: Specifies database size. type: - integer - 'null' format: int64 x-go-name: Size tdeEncryptedTsCount: description: Specifies the number of TDE encrypted tablespaces found in the database. type: - integer - 'null' format: int64 x-go-name: TdeEncryptedTsCount tempFilesCount: description: Specifies number of temporary files for the current DB entity. type: - integer - 'null' format: int64 x-go-name: TempFilesCount type: description: 'Specifies the type of the managed Object in Oracle Protection Source. ''kRACRootContainer'' indicates the entity is a root container to an Oracle Real Application clusters(Oracle RAC). ''kRootContainer'' indicates the entity is a root container to an Oracle standalone server. ''kHost'' indicates the entity is an Oracle host. ''kDatabase'' indicates the entity is an Oracle Database. ''kTableSpace'' indicates the entity is an Oracle table space. ''kTable'' indicates the entity is an Oracle table.' type: - string - 'null' enum: - kRACRootContainer - kRootContainer - kHost - kDatabase - kTableSpace - kTable x-go-name: Type uuid: description: Specifies the UUID for the Oracle entity. type: - string - 'null' x-go-name: Uuid version: description: Specifies the Oracle database instance version. type: - string - 'null' x-go-name: Version x-go-package: cohesity/iris/server/data/public HiveProtectionSource: description: Specifies an Object representing Hive. type: object title: Hive Protection Source. properties: name: description: Specifies the instance name of the Hive entity. type: - string - 'null' x-go-name: Name tableInfo: description: 'Information of a Hive Table, only valid for an entity of type kTable.' $ref: '#/components/schemas/HiveTable' type: description: 'Specifies the type of the managed Object in Hive Protection Source. Specifies the type of an Hive source entity. ''kCluster'' indicates a Hive cluster distributed over several physical nodes. ''kDatabase'' indicates a Database in the Hive environment. ''kTable'' indicates a Table in the Hive environment.' type: - string - 'null' enum: - kCluster - kDatabase - kTable x-go-name: Type uuid: description: Specifies the UUID for the Hive entity. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public 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 OracleHost: description: Specifies information about an Oracle Host. type: object title: Oracle Host. properties: cpuCount: description: Specifies the count of CPU available on the host. type: - integer - 'null' format: int32 x-go-name: CpuCount ipAddresses: description: Specifies the IP address of the host. type: - array - 'null' items: type: string x-go-name: IpAddresses ports: description: Specifies ports available for this host. type: - array - 'null' items: type: integer format: int64 x-go-name: Ports sessions: description: Specifies multiple session configurations available for this host. type: - array - 'null' items: $ref: '#/components/schemas/OracleSession' x-go-name: Sessions x-go-package: cohesity/iris/server/data/public ListStorageProfilesResponseBody: description: 'Specifies the response to request to list the storage profiles associated with a VDC.' type: object title: List Storage Profiles Response Body. properties: storageProfiles: description: Specifies a list of storage profiles. type: - array - 'null' items: $ref: '#/components/schemas/VcdStorageProfile' x-go-name: StorageProfiles x-go-package: cohesity/iris/server/data/public FileSnapshotInformation: description: 'Specifies the information about the snapshot that contains the file or folder. In addition, information about the file or folder is provided.' type: object title: File/Folder Snapshot Information. properties: hasArchivalCopy: description: 'If true, this snapshot is located on an archival target (such as a tape or AWS).' type: - boolean - 'null' x-go-name: HasArchivalCopy hasLocalCopy: description: If true, this snapshot is located on a local Cohesity Cluster. type: - boolean - 'null' x-go-name: HasLocalCopy hasRemoteCopy: description: If true, this snapshot is located on a Remote Cohesity Cluster. type: - boolean - 'null' x-go-name: HasRemoteCopy modifiedTimeUsecs: description: 'Specifies the time when the file or folder was last modified. Specified as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: ModifiedTimeUsecs replicaInfoList: description: Specifies the list of replication information about the current snapshot. type: - array - 'null' items: $ref: '#/components/schemas/ReplicaInfo' x-go-name: ReplicaInfoList sizeBytes: description: Specifies the size of the file or folder in bytes. type: - integer - 'null' format: int64 x-go-name: SizeBytes snapshot: description: Specifies the snapshot that contains the specified file or folder. $ref: '#/components/schemas/SnapshotAttempt' x-go-package: cohesity/iris/server/data/public VmwareCloneParameters: description: Specifies the information required for recovering or cloning VmWare VMs. type: object title: VmWare Clone Parameters. properties: datastoreFolderId: description: 'Specifies the folder where the restore datastore should be created. This is applicable only when the VMs are being cloned.' type: - integer - 'null' format: int64 x-go-name: DatastoreFolderId detachNetwork: description: 'Specifies whether the network should be detached from the recovered or cloned VMs.' type: - boolean - 'null' x-go-name: DetachNetwork disableNetwork: description: 'Specifies whether the network should be left in disabled state. Attached network is enabled by default. Set this flag to true to disable it.' type: - boolean - 'null' x-go-name: DisableNetwork networkId: description: 'Specifies a network configuration to be attached to the cloned or recovered object. For kCloneVMs and kRecoverVMs tasks, original network configuration is detached if the cloned or recovered object is kept under a different parent Protection Source or a different Resource Pool. By default, for kRecoverVMs task, original network configuration is preserved if the recovered object is kept under the same parent Protection Source and the same Resource Pool. Specify this field to override the preserved network configuration or to attach a new network configuration to the cloned or recovered objects. You can get the networkId of the kNetwork object by setting includeNetworks to ''true'' in the GET /public/protectionSources operation. In the response, get the id of the desired kNetwork object, the resource pool, and the registered parent Protection Source.' type: - integer - 'null' format: int64 x-go-name: NetworkId networkMappings: description: 'Specifies the parameters for mapping the source and target networks. This field can be used if restoring to a different parent source. This will replace the NetworkId and DisableNetwork that are used to provide configuration for a single network. Unless the support for mapping is available for all the entities old keys can be used to attach a new network. Supports ''kVMware'' for now.' type: - array - 'null' items: $ref: '#/components/schemas/NetworkMapping' x-go-name: NetworkMappings poweredOn: description: 'Specifies the power state of the cloned or recovered objects. By default, the cloned or recovered objects are powered off.' type: - boolean - 'null' x-go-name: KeepPoweredOn prefix: description: 'Specifies a prefix to prepended to the source object name to derive a new name for the recovered or cloned object. By default, cloned or recovered objects retain their original name. Length of this field is limited to 8 characters.' type: - string - 'null' x-go-name: Prefix preserveCustomAttributesDuringClone: description: 'Specifies whether or not to preserve the custom attributes during the clone operation. The default behavior is ''true''.' type: - boolean - 'null' x-go-name: PreserveCustomAttributesDuringClone preserveTags: description: 'Specifies whether or not to preserve tags during the clone operation. The default behavior is ''true''.' type: - boolean - 'null' x-go-name: PreserveTags recoveryProcessType: description: 'Specifies the type of recovery process to be performed. If unspecified, then an instant recovery will be performed. Specifies the recovery process type to be used.. ''kInstantRecovery'' indicates that an instant recovery should be performed. ''kCopyRecovery'' indicates that a copy recovery should be performed.' type: - string - 'null' enum: - kInstantRecovery - kCopyRecovery x-go-name: RecoveryProcessType resourcePoolId: description: 'Specifies the resource pool where the cloned or recovered objects are attached. This field is mandatory for kCloneVMs Restore Tasks always. For kRecoverVMs Restore Tasks, this field is mandatory only if newParentId field is specified. If this field is not specified, recovered objects are attached to the original resource pool under the original parent.' type: - integer - 'null' format: int64 x-go-name: ResourcePoolId storageProfileName: description: 'Specifies the name of the destination storage profile while restoring to an alternate VCD location.' type: - string - 'null' x-go-name: StorageProfileName storageProfileVcdUuid: description: 'Specifies the UUID of the storage profile while restoring to an alternate VCD location.' type: - string - 'null' x-go-name: StorageProfileVcdUuid suffix: description: 'Specifies a suffix to appended to the original source object name to derive a new name for the recovered or cloned object. By default, cloned or recovered objects retain their original name. Length of this field is limited to 8 characters.' type: - string - 'null' x-go-name: Suffix vAppId: description: Specifies the ID of the vApp to which a VM should be restored. type: - integer - 'null' format: int64 x-go-name: VAppId vdcId: description: Specifies the ID of the VDC to which a VM should be restored. type: - integer - 'null' format: int64 x-go-name: VdcId vmFolderId: description: 'Specifies a folder where the VMs should be restored. This is applicable only when the VMs are being restored to an alternate location or if clone is being performed.' type: - integer - 'null' format: int64 x-go-name: VmFolderId x-go-package: cohesity/iris/server/data/public CassandraProtectionSource: description: Specifies an Object representing Cassandra. type: object title: Cassandra Protection Source. properties: clusterInfo: description: 'Information of a Cassandra cluster, only valid for an entity of type kCluster.' $ref: '#/components/schemas/CassandraCluster' keyspaceInfo: description: 'Information of a cassandra keyspapce, only valid for an entity of type kKeyspace.' $ref: '#/components/schemas/CassandraKeyspace' name: description: Specifies the instance name of the Cassandra entity. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of the managed Object in Cassandra Protection Source. Replication strategy options for a keyspace. ''kCluster'' indicates a Cassandra cluster distributed over several physical nodes. ''kKeyspace'' indicates a Keyspace enclosing one or more tables. ''kTable'' indicates a Table in the Cassandra environment.' type: - string - 'null' enum: - kCluster - kKeyspace - kTable x-go-name: Type uuid: description: 'Specifies the UUID for the Cassandra entity. Note : For each entity an ID unique within top level entity should be assigned by imanis backend. Example, UUID for a table can be the string .' type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public QoS: description: Specifies the Quality of Service (QoS) Policy for the View. type: object title: QoS. properties: principalId: description: Specifies the name of the QoS Policy used for the View. type: - integer - 'null' format: int64 x-go-name: PrincipalId principalName: description: 'Specifies the name of the QoS Policy used for the View such as ''TestAndDev High'', ''Backup Target SSD'', ''Backup Target High'' ''TestAndDev Low'' and ''Backup Target Low''. For a complete list and descriptions, see the ''Create or Edit Views'' topic in the documentation. If not specified, the default is ''Backup Target Low''.' type: - string - 'null' x-go-name: PrincipalName x-go-package: cohesity/iris/server/data/public ApplicationServerInfo: description: Specifies the Information about the Exchange Server Node. type: object title: Application Server Info properties: databaseCopyInfoList: description: 'Specifies the list of all the copies of the Exchange databases(that are part of DAG) that are present on this Exchange Node.' type: - array - 'null' items: $ref: '#/components/schemas/ExchangeDatabaseCopyInfo' x-go-name: DatabaseCopyInfoList databaseInfoList: description: 'Specifies the list of all the databases available on the standalone Exchange server node. This is populated for the Standlone Exchange Servers.' type: - array - 'null' items: $ref: '#/components/schemas/ExchangeDatabaseInfo' x-go-name: DatabaseInfoList fqdn: description: Specifies the fully qualified domain name of the Exchange Server. type: - string - 'null' x-go-name: Fqdn guid: description: Specifies the Guid of the Exchange Application Server. type: - string - 'null' x-go-name: Guid name: description: Specifies the display name of the Exchange Application Server. type: - string - 'null' x-go-name: Name totalSizeBytes: description: 'Specifies the total size of all Exchange database copies in all the Exchange Application Servers that are part of the DAG.' type: - integer - 'null' format: int64 x-go-name: TotalSizeBytes x-go-package: cohesity/iris/server/data/public EmailMetaData: description: Specifies details about the emails and the folder containing emails. type: object title: Email Meta Data. properties: allUnderHierarchy: description: 'AllUnderHierarchy specifies if logs of all the tenants under the hierarchy of tenant with id TenantId should be returned.' type: - boolean - 'null' x-go-name: AllUnderHierarchy bccRecipientAddresses: description: Specifies the email addresses of the bcc recipients. type: - array - 'null' items: type: string x-go-name: BccRecipientAddresses ccRecipientAddresses: description: Specifies the email addresses of the cc recipients. type: - array - 'null' items: type: string x-go-name: CcRecipientAddresses domainIds: description: Specifies the domain Ids in which mailboxes are registered. type: - array - 'null' items: type: integer format: int64 x-go-name: DomainIds emailSubject: description: Specifies the subject of the email. type: - string - 'null' x-go-name: EmailSubject folderKey: description: Specifes the Parent Folder key. type: - integer - 'null' format: int64 x-go-name: FolderKey folderName: description: Specifies the parent folder name of the email. type: - string - 'null' x-go-name: FolderName hasAttachments: description: Specifies whether the emails have any attachments. type: - boolean - 'null' x-go-name: HasAttachments itemKey: description: 'Specifies the Key(unique within mailbox) for Outlook item such as Email. This key is not indexed but used for identifying the item while restore.' type: - string - 'null' x-go-name: ItemKey mailboxIds: description: Specifies the mailbox Ids which contains the emails/folders. type: - array - 'null' items: type: integer format: int64 x-go-name: MailboxIds protectionJobIds: description: 'Specifies the protection job Ids which have backed up mailbox(es) continaing emails/folders.' type: - array - 'null' items: type: integer format: int64 x-go-name: ProtectionJobIds receivedEndTime: description: Specifies the unix end time for querying on email's received time. type: - integer - 'null' format: int64 x-go-name: ReceivedEndTime receivedStartTime: description: Specifies the unix start time for querying on email's received time. type: - integer - 'null' format: int64 x-go-name: ReceivedStartTime receivedTimeSeconds: description: Specifies the unix time when the email was received. type: - integer - 'null' format: int64 x-go-name: ReceivedTimeSeconds recipientAddresses: description: Specifies the email addresses of the recipients. type: - array - 'null' items: type: string x-go-name: RecipientAddresses senderAddress: description: Specifies the email address of the sender. type: - string - 'null' x-go-name: SenderAddress sentTimeSeconds: description: Specifies the unix time when the email was sent. type: - integer - 'null' format: int64 x-go-name: SentTimeSeconds showOnlyEmailFolders: description: Specifies whether the query result should include only Email folders. type: - boolean - 'null' x-go-name: ShowOnlyEmailFolders tenantId: description: TenantId specifies the tenant whose action resulted in the audit log. type: - string - 'null' x-go-name: TenantId x-go-package: cohesity/iris/server/data/public IsilonAccessZone: description: Specifies information about access zone in an Isilon Cluster. type: object title: Isilon Access Zone. properties: id: description: Specifies the id of the access zone. type: - integer - 'null' format: int64 x-go-name: Id name: description: Specifies the name of the access zone. type: - string - 'null' x-go-name: Name path: description: 'Specifies the path of the access zone in ifs. This should include the leading "/ifs/".' type: - string - 'null' x-go-name: Path x-go-package: cohesity/iris/server/data/public ExchangeDAGDatabase: description: 'Specifies the information about all the copies of the database that is part of DAG.' type: object title: Exchange DAG database Information properties: databaseCopyInfoList: description: 'Specifies about all the copies of this DAG database. This include active and passive copy of the database.' type: - array - 'null' items: $ref: '#/components/schemas/ExchangeDatabaseCopyInfo' x-go-name: DatabaseCopyInfoList guid: description: Specifies the guid of the database. type: - string - 'null' x-go-name: Guid name: description: Specifies the name of the database. type: - string - 'null' x-go-name: Name x-go-package: cohesity/iris/server/data/public DeviceNode: description: 'Specifies the list of devices that need to be combined to form the storage space. Only one of the fields is populated with a device node. If the device node is a leaf node, leafNode is populated with details about the partition blocks in the file. If the device node is an intermediate node, intermediateNode is populated with a device sub-tree.' type: object title: Device Node. properties: intermediateNode: description: Specifies an intermediate node of the logical device tree. $ref: '#/components/schemas/DeviceTreeDetails' leafNode: description: Specifies the leaf node of the device tree. $ref: '#/components/schemas/FilePartitionBlock' x-go-package: cohesity/iris/server/data/public ReplicationTargetSettings: description: 'Specifies settings about the Remote Cohesity Cluster where Snapshots are copied to.' type: object title: Replication Target. properties: clusterId: description: Specifies the id of the Remote Cluster. type: - integer - 'null' format: int64 x-go-name: ClusterId clusterName: description: Specifies the name of the Remote Cluster. type: - string - 'null' x-go-name: ClusterName x-go-package: cohesity/iris/server/data/public IsilonCluster: description: Specifies information about an Isilon Cluster. type: object title: Isilon Cluster. properties: apiVersionStr: description: Specifies the API version of an Isilon Cluster as string. type: - string - 'null' x-go-name: ApiVersionStr description: description: Specifies the description of an Isilon Cluster. type: - string - 'null' x-go-name: Description guid: description: Specifies a globally unique id of an Isilon Cluster. type: - string - 'null' x-go-name: Guid version: description: Specifies the version of an Isilon Cluster. type: - string - 'null' x-go-name: Version x-go-package: cohesity/iris/server/data/public 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 AgentInformation: description: 'Specifies information about the Agent software running on the server or the Virtual Machine.' type: object title: Agent Information. properties: cbmrVersion: description: Specifies the version if Cristie BMR product is installed on the host. type: - string - 'null' x-go-name: CbmrVersion hostType: description: 'Specifies the host type where the agent is running. This is only set for persistent agents. ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: HostType id: description: Specifies the agent's id. type: - integer - 'null' format: int64 x-go-name: Id name: description: Specifies the agent's name. type: - string - 'null' x-go-name: Name oracleMultiNodeChannelSupported: description: Specifies whether oracle multi node multi channel is supported or not. type: - boolean - 'null' x-go-name: OracleMultiNodeChannelSupported registrationInfo: description: Specifies registration information for an Agent. $ref: '#/components/schemas/RegisteredSourceInfo' sourceSideDedupEnabled: description: Specifies whether source side dedup is enabled or not. type: - boolean - 'null' x-go-name: SourceSideDedupEnabled status: description: 'Specifies the agent status. Specifies the status of the agent running on a physical source. ''kUnknown'' indicates the Agent is not known. No attempt to connect to the Agent has occurred. ''kUnreachable'' indicates the Agent is not reachable. ''kHealthy'' indicates the Agent is healthy. ''kDegraded'' indicates the Agent is running but in a degraded state.' type: - string - 'null' enum: - kUnknown - kUnreachable - kHealthy - kDegraded x-go-name: Status statusMessage: description: Specifies additional details about the agent status. type: - string - 'null' x-go-name: StatusMessage upgradability: description: 'Specifies the upgradability of the agent running on the physical server. Specifies the upgradability of the agent running on the physical server. ''kUpgradable'' indicates the Agent can be upgraded to the agent software version on the cluster. ''kCurrent'' indicates the Agent is running the latest version. ''kUnknown'' indicates the Agent''s version is not known. ''kNonUpgradableInvalidVersion'' indicates the Agent''s version is invalid. ''kNonUpgradableAgentIsNewer'' indicates the Agent''s version is newer than the agent software version the cluster. ''kNonUpgradableAgentIsOld'' indicates the Agent''s version is too old that does not support upgrades.' type: - string - 'null' enum: - kUpgradable - kCurrent - kUnknown - kNonUpgradableInvalidVersion - kNonUpgradableAgentIsNewer - kNonUpgradableAgentIsOld x-go-name: Upgradability upgradeStatus: description: 'Specifies the status of the upgrade of the agent on a physical server. Specifies the status of the upgrade of the agent on a physical server. ''kIdle'' indicates there is no agent upgrade in progress. ''kAccepted'' indicates the Agent upgrade is accepted. ''kStarted'' indicates the Agent upgrade is in progress. ''kFinished'' indicates the Agent upgrade is completed.' type: - string - 'null' enum: - kIdle - kAccepted - kStarted - kFinished x-go-name: UpgradeStatus upgradeStatusMessage: description: 'Specifies detailed message about the agent upgrade failure. This field is not set for successful upgrade.' type: - string - 'null' x-go-name: UpgradeStatusMessage version: description: Specifies the version of the Agent software. type: - string - 'null' x-go-name: Version x-go-package: cohesity/iris/server/data/public 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 SharepointDocumentMetadata: description: Specifies the metadata for the Sharepoint Site document. type: object title: Sharepoint Site document metadata. properties: documentType: description: 'Specifies the type of site document(file/folder). Specifies the Sharepoint document type. ''kFile'' specifies a file. ''kFolder'' specifies a folder.' type: - string - 'null' enum: - kFile - kFolder x-go-name: DocumentType x-go-package: cohesity/iris/server/data/public CloneViewRequest: description: Specifies the settings for cloning an existing View. type: object title: Clone View Request. properties: accessSids: description: 'Array of Security Identifiers (SIDs) Specifies the list of security identifiers (SIDs) for the restricted Principals who have access to this View.' type: - array - 'null' items: type: string x-go-name: AccessSids antivirusScanConfig: description: Specifies the antivirus scan config settings for this View. $ref: '#/components/schemas/AntivirusScanConfig' cloneViewName: description: Specifies the name of the new View that is cloned from the source View. type: - string - 'null' x-go-name: CloneViewName dataLockExpiryUsecs: description: 'DataLock (Write Once Read Many) lock expiry epoch time in microseconds. If specified, a view will be marked as a DataLock view. If a view is marked as a DataLock view, only a Data Security Officer (a user having Data Security Privilege) can delete the view until the lock expiry time.' type: - integer - 'null' format: int64 x-go-name: DataLockExpiryUsecs description: description: Specifies an optional text description about the View. type: - string - 'null' x-go-name: Description enableFastDurableHandle: description: 'Specifies whether fast durable handle is enabled. If enabled, view open handle will be kept in memory, which results in a higher performance. But the handles cannot be recovered if node or service crashes.' type: - boolean - 'null' x-go-name: EnableFastDurableHandle enableFilerAuditLogging: description: Specifies if Filer Audit Logging is enabled for this view. type: - boolean - 'null' x-go-name: EnableFilerAuditLogging enableLiveIndexing: description: Specifies whether to enable live indexing for the view. type: - boolean - 'null' x-go-name: EnableLiveIndexing enableMixedModePermissions: description: 'If set, mixed mode (NFS and SMB) access is enabled for this view. This field is deprecated. Use the field SecurityMode. deprecated: true' type: - boolean - 'null' x-go-name: EnableMixedModePermissions enableNfsViewDiscovery: description: If set, it enables discovery of view for NFS. type: - boolean - 'null' x-go-name: EnableNfsViewDiscovery enableOfflineCaching: description: Specifies whether to enable offline file caching of the view. type: - boolean - 'null' x-go-name: EnableOfflineCaching enableSmbAccessBasedEnumeration: description: 'Specifies if access-based enumeration should be enabled. If ''true'', only files and folders that the user has permissions to access are visible on the SMB share for that user.' type: - boolean - 'null' x-go-name: EnableSmbAccessBasedEnumeration enableSmbEncryption: description: 'Specifies the SMB encryption for the View. If set, it enables the SMB encryption for the View. Encryption is supported only by SMB 3.x dialects. Dialects that do not support would still access data in unencrypted format.' type: - boolean - 'null' x-go-name: EnableSmbEncryption enableSmbOplock: description: Specifies whether SMB opportunistic lock is enabled. type: - boolean - 'null' x-go-name: EnableSmbOplock enableSmbViewDiscovery: description: If set, it enables discovery of view for SMB. type: - boolean - 'null' x-go-name: EnableSmbViewDiscovery enforceSmbEncryption: description: 'Specifies the SMB encryption for all the sessions for the View. If set, encryption is enforced for all the sessions for the View. When enabled all future and existing unencrypted sessions are disallowed.' type: - boolean - 'null' x-go-name: EnforceSmbEncryption fileExtensionFilter: description: 'Optional filtering criteria that should be satisfied by all the files created in this view. It does not affect existing files.' $ref: '#/components/schemas/FileExtensionFilter' fileLockConfig: description: 'Optional config that enables file locking for this view. It cannot be disabled during the edit of a view, if it has been enabled during the creation of the view. Also, it cannot be enabled if it was disabled during the creation of the view.' $ref: '#/components/schemas/FileLevelDataLockConfig' logicalQuota: description: 'Specifies an optional logical quota limit (in bytes) for the usage allowed on this View. (Logical data is when the data is fully hydrated and expanded.) This limit overrides the limit inherited from the Storage Domain (View Box) (if set). If logicalQuota is nil, the limit is inherited from the Storage Domain (View Box) (if set). A new write is not allowed if the Storage Domain (View Box) will exceed the specified quota. However, it takes time for the Cohesity Cluster to calculate the usage across Nodes, so the limit may be exceeded by a small amount. In addition, if the limit is increased or data is removed, there may be a delay before the Cohesity Cluster allows more data to be written to the View, as the Cluster is calculating the usage across Nodes.' allOf: - $ref: '#/components/schemas/QuotaPolicy' netgroupWhitelist: description: 'Array of Netgroups. Specifies a list of Netgroups that have permissions to access the View. (Overrides the Netgroups specified at the global Cohesity Cluster level.)' type: - array - 'null' items: $ref: '#/components/schemas/NisNetgroup' x-go-name: NetgroupWhitelist nfsAllSquash: description: Specifies the NFS all squash config. $ref: '#/components/schemas/NfsSquash' nfsRootPermissions: description: Specifies the NFS root permission config of the view file system. $ref: '#/components/schemas/NfsRootPermissions' nfsRootSquash: description: Specifies the NFS root squash config. $ref: '#/components/schemas/NfsSquash' overrideGlobalNetgroupWhitelist: description: 'Specifies whether view level client netgroup whitelist overrides cluster and global setting.' type: - boolean - 'null' x-go-name: OverrideGlobalNetgroupWhitelist overrideGlobalWhitelist: description: 'Specifies whether view level client subnet whitelist overrides cluster and global setting.' type: - boolean - 'null' x-go-name: OverrideGlobalWhitelist protocolAccess: description: 'Specifies the supported Protocols for the View. ''kAll'' enables protocol access to following three views: NFS, SMB and S3. ''kNFSOnly'' enables protocol access to NFS only. ''kSMBOnly'' enables protocol access to SMB only. ''kS3Only'' enables protocol access to S3 only. ''kSwiftOnly'' enables protocol access to Swift only.' type: - string - 'null' enum: - kAll - kNFSOnly - kSMBOnly - kS3Only - kSwiftOnly x-go-name: ProtocolAccess qos: description: Specifies the Quality of Service (QoS) Policy for the View. $ref: '#/components/schemas/QoS' securityMode: description: 'Specifies the security mode used for this view. Currently we support the following modes: Native, Unified and NTFS style. ''kNativeMode'' indicates a native security mode. ''kUnifiedMode'' indicates a unified security mode. ''kNtfsMode'' indicates a NTFS style security mode.' type: - string - 'null' enum: - kNativeMode - kUnifiedMode - kNtfsMode x-go-name: SecurityMode sharePermissions: description: Specifies a list of share level permissions. type: - array - 'null' items: $ref: '#/components/schemas/SmbPermission' x-go-name: SharePermissions smbPermissionsInfo: description: Specifies the SMB permissions for the View. $ref: '#/components/schemas/SmbPermissionsInfo' sourceViewName: description: Specifies the name of the source View that will be cloned. type: - string - 'null' x-go-name: SourceViewName storagePolicyOverride: description: 'Specifies if inline deduplication and compression settings inherited from the Storage Domain (View Box) should be disabled for this View.' $ref: '#/components/schemas/StoragePolicyOverride' subnetWhitelist: description: 'Array of Subnets. Specifies a list of Subnets with IP addresses that have permissions to access the View. (Overrides the Subnets specified at the global Cohesity Cluster level.)' type: - array - 'null' items: $ref: '#/components/schemas/Subnet' x-go-name: SubnetWhitelist swiftProjectDomain: description: Specifies the Keystone project domain. type: - string - 'null' x-go-name: SwiftProjectDomain swiftProjectName: description: Specifies the Keystone project name. type: - string - 'null' x-go-name: SwiftProjectName tenantId: description: Optional tenant id who has access to this View. type: - string - 'null' x-go-name: TenantId viewLockEnabled: description: 'Specifies whether view lock is enabled. If enabled the view cannot be modified or deleted until unlock. By default it is disabled.' type: - boolean - 'null' x-go-name: ViewLockEnabled x-go-package: cohesity/iris/server/data/public AdDomainIdentity: description: AD domain identity information. type: object title: AD Domain Identity. properties: dn: description: Specifies distinguished name of the domain. type: - string - 'null' x-go-name: Dn guid: description: Specifies Unique objectGUID for an AD domain. type: - string - 'null' x-go-name: ObjectGuid name: description: Specifies display name of the domain. type: - string - 'null' x-go-name: Name sid: description: Specifies domain SID. type: - string - 'null' x-go-name: Sid x-go-package: cohesity/iris/server/data/public RecoverTaskRequest: description: 'Create a Restore Task Request for recovering VMs or mounting volumes to mount points.' type: object title: Create Restore Task Request. required: - name - type properties: PublicFoldersParameters: description: 'Specifies additional parameters for ''kRecoverO365PublicFolders'' restore objects.' $ref: '#/components/schemas/PublicFoldersRestoreParameters' acropolisParameters: description: Specifies additional parameters for 'kAcropolis' restore objects. $ref: '#/components/schemas/AcropolisRestoreParameters' 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 deployVmsToCloud: description: Specifies parameters to deploy VMs to cloud. $ref: '#/components/schemas/DeployVmsToCloud' glacierRetrievalType: description: 'Specifies the way data needs to be retrieved from the external target. This information will be filled in by Iris and Magneto will pass it along to the Icebox as it is to support bulk retrieval from Glacier. Specifies the type of Restore Task. ''kStandard'' specifies retrievals that allow to access any of your archives within several hours. Standard retrievals typically complete within 3–5 hours. This is the default option for retrieval requests that do not specify the retrieval option. ''kBulk'' specifies retrievals that are Glacier’s lowest-cost retrieval option, which can be used to retrieve large amounts, even petabytes, of data inexpensively in a day. Bulk retrieval typically complete within 5–12 hours. ''kExpedited'' specifies retrievals that allows to quickly access your data when occasional urgent requests for a subset of archives are required. For all but the largest archives (250 MB+), data accessed using Expedited retrievals are typically made available within 1–5 minutes.' type: - string - 'null' enum: - kStandard - kBulk - kExpedited x-go-name: GlacierRetrievalType hypervParameters: description: Specifies additional parameters for 'kHyperV' restore objects. $ref: '#/components/schemas/HypervRestoreParameters' kubernetesParameters: description: Specifies additional parameters for 'kKubernetes' restore objects. $ref: '#/components/schemas/KubernetesRestoreParameters' mountParameters: description: Specifies parameters required for mounting volumes. $ref: '#/components/schemas/MountVolumesParameters' 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 oneDriveParameters: description: Specifies additional parameters for 'kRecoverO365Drive' restore objects. $ref: '#/components/schemas/OneDriveRestoreParameters' outlookParameters: description: Specifies additional parameters for 'kRecoverEmails' restore objects. $ref: '#/components/schemas/OutlookRestoreParameters' restoreViewParameters: description: Specifies settings for restoring view. title: Restore View. $ref: '#/components/schemas/UpdateViewParam' sharePointParameters: description: Specifies additional parameters for 'kRecoverSites' restore objects. $ref: '#/components/schemas/SharePointRestoreParameters' type: description: 'Specifies the type of Restore Task such as ''kRecoverVMs'' or ''kMountVolumes''. ''kRecoverVMs'' specifies a Restore Task that recovers VMs. ''kMountVolumes'' specifies a Restore Task that mounts volumes to mount points. ''kRecoverNamespaces'' specifies a Restore Task that recovers Kubernetes namespaces. ''kMountFileVolume'' specifies a Restore Task that mounts a file volume.' type: - string - 'null' enum: - kRecoverVMs - kMountVolumes - kRecoverNamespaces - kMountFileVolume x-go-name: Type viewName: description: 'Specifie target view into which the objects are to be cloned when doing recovery for NAS.' type: - string - 'null' x-go-name: ViewName virtualDiskRestoreParameters: description: Specifies parameters for restoring virtual disks from VM. $ref: '#/components/schemas/VirtualDiskRestoreParameters' vlanParameters: description: Specifies VLAN parameters for the restore operation. $ref: '#/components/schemas/VlanParameters' vmwareParameters: description: Specifies additional parameters for 'kVmware' restore objects. $ref: '#/components/schemas/VmwareRestoreParameters' x-go-package: cohesity/iris/server/data/public ThrottlingPolicyOverride: description: Specifies throttling policy override for a Datastore in a registered entity. type: object title: Throttling Policy Override. properties: datastoreId: description: Specifies the Protection Source id of the Datastore. type: - integer - 'null' format: int64 x-go-name: DatastoreId datastoreName: description: Specifies the display name of the Datastore. type: - string - 'null' x-go-name: DatastoreName throttlingPolicy: description: Specifies the throttling policy that should be applied to this Source. $ref: '#/components/schemas/ThrottlingPolicyParameters' x-go-package: cohesity/iris/server/data/public NasMountCredentialParams: description: Specifies the credentials to mount a volume on a NetApp server. type: object title: NAS Mount Credentials. properties: domain: description: Specifies the domain in which this credential is valid. type: - string - 'null' x-go-name: Domain domainController: description: Specifies the domain controller for the selected domain type: - string - 'null' x-go-name: DomainController managePasswordByCohesity: description: Specifies if Cohesity can manage the password after registration type: - boolean - 'null' x-go-name: ManagePasswordByCohesity nasProtocol: description: 'Specifies the protocol used by the NAS server. Specifies the protocol used by a NAS server. ''kNfs3'' indicates NFS v3 protocol. ''kCifs1'' indicates CIFS v1.0 protocol.' type: - string - 'null' enum: - kNfs3 - kCifs1 x-go-name: NasProtocol nasType: description: 'Specifies the type of a NAS Object such as ''kGroup'', or ''kHost''. Specifies the kind of NAS mount. ''kGroup'' indicates top level node that holds individual NAS hosts. ''kHost'' indicates a single NAS path that can be mounted. ''kDfsGroup'' indicates a DFS group containing top level directories mapped to different servers. ''kDfsTopDir'' indicates a top level directory inside a DFS group, discovered when registering a DFS group.' type: - string - 'null' enum: - kGroup - kHost - kDfsGroup - kDfsTopDir x-go-name: NasType password: description: Specifies the password for the username to use for mounting the NAS. type: - string - 'null' x-go-name: Password skipValidation: description: 'Specifies the flag to disable mount point validation during registration process.' type: - boolean - 'null' x-go-name: SkipValidation username: description: Specifies a username to use for mounting the NAS. type: - string - 'null' x-go-name: Username x-go-package: cohesity/iris/server/data/public ProtectionSourceAndApplicationRestoreObjects: description: 'Specifies the details about the protection source and snapshot from where the application objects must be restored. It also provides information about the application objects which have to be restored and target host to which the application objects must be restored.' type: object title: Protection source and Application restore objects. required: - hostingProtectionSource properties: applicationRestoreObjects: description: 'Specifies the Application Server objects whose data should be restored and the restore parameters for each of them.' type: - array - 'null' items: $ref: '#/components/schemas/ApplicationRestoreObject' x-go-name: ApplicationRestoreObjects hostingProtectionSource: description: 'Specifies the restore information for the Protection Source object that registered and hosts the Application Servers. This provides the snapshot details from which the applications should be restored.' $ref: '#/components/schemas/RestoreObjectDetails' x-go-package: cohesity/iris/server/data/public NetworkingInformation: description: 'Specifies the struct containing information about network addresses configured on the given box. This is needed for dealing with Windows/Oracle Cluster resources that we discover and protect automatically.' type: object title: Networking Information. properties: resourceVec: description: 'The list of resources on the system that are accessible by an IP address.' type: - array - 'null' items: $ref: '#/components/schemas/ClusterNetworkingResourceInformation' x-go-name: ResourceVec x-go-package: cohesity/iris/server/data/public VMwareObjectId: description: 'Specifies a unique Protection Source id across Cohesity Clusters. It is derived from the id of the VMware Protection Source.' type: object title: VMware Object Id. properties: morItem: description: Specifies the Managed Object Reference Item. type: - string - 'null' x-go-name: MorItem morType: description: Specifies the Managed Object Reference Type. type: - string - 'null' x-go-name: MorType uuid: description: Specifies a Universally Unique Identifier (UUID) of a VMware Object. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public NfsSquash: type: object title: NfsSquash specifies the squash config for client subnet whitelist. properties: gid: description: GID mapped for all clients. type: - integer - 'null' format: uint32 x-go-name: Gid uid: description: UID mapped for all clients. type: - integer - 'null' format: uint32 x-go-name: Uid x-go-package: cohesity/iris/server/data/public NetappVserverInfo: description: Specifies information about a NetApp Vserver in a NetApp Protection Source. type: object title: NetApp Vserver Information. properties: dataProtocols: description: 'Array of Data Protocols. Specifies the set of data protocols supported by this Vserver. The kManagement protocol is not supported for this case. ''kNfs'' indicates NFS connections. ''kCifs'' indicates SMB (CIFS) connections. ''kIscsi'' indicates iSCSI connections. ''kFc'' indicates Fiber Channel connections. ''kFcache'' indicates Flex Cache connections. ''kHttp'' indicates HTTP connections. ''kNdmp'' indicates NDMP connections. ''kManagement'' indicates non-data connections used for management purposes. ''kNvme'' indicates NVMe connections.' type: - array - 'null' items: type: string enum: - kNfs - kCifs - kIscsi - kFc - kFcache - kHttp - kNdmp - kManagement - kNvme x-go-name: DataProtocols interfaces: description: 'Array of Interfaces. Specifies information about all interfaces on this Vserver.' type: - array - 'null' items: $ref: '#/components/schemas/VserverNetworkInterface' x-go-name: Interfaces rootCifsShare: description: 'Specifies the root ''c$'' CIFS share of this Vserver. If it exists, it can be used to mount all CIFS volumes that are junctioned under ''/'' on this Vserver.' $ref: '#/components/schemas/CifsShareInfo' type: description: 'Specifies the type of this Vserver. Specifies the type of the NetApp Vserver. ''kData'' indicates the Vserver is used for data backup and restore. ''kAdmin'' indicates the Vserver is used for cluster-wide management. ''kSystem'' indicates the Vserver is used for cluster-scoped communications in an IPspace. ''kNode'' indicates the Vserver is used as the physical controller. ''kUnknown'' indicates the Vserver is used for an unknown purpose.' type: - string - 'null' enum: - kData - kAdmin - kSystem - kNode - kUnknown x-go-name: Type x-go-package: cohesity/iris/server/data/public SanStorageArray: description: Specifies a SAN Storage Array. type: object title: SAN Storage Array. properties: id: description: 'Specifies a unique id of a SAN Storage Array. The id is unique across Cohesity Clusters.' type: - string - 'null' x-go-name: Id ports: description: Specifies the SAN ports of the SAN Storage Array. type: - array - 'null' items: $ref: '#/components/schemas/IscsiSanPort' x-go-name: Ports revision: description: Specifies the revision of the SAN Storage Array. type: - string - 'null' x-go-name: Revision version: description: Specifies the version of the SAN Storage Array. type: - string - 'null' x-go-name: Version x-go-package: cohesity/iris/server/data/public CouchbaseBucket: description: Specifies an Object containing information about a couchbase Bucket. type: object title: Couchbase Bucket Info. properties: bucketType: description: Type of this bucket. type: - string - 'null' x-go-name: BucketType documentCount: description: Number of documents in this bucket. type: - integer - 'null' format: int64 x-go-name: DocumentCount x-go-package: cohesity/iris/server/data/public IsilonSmbMountPoint: description: 'Specifies information specific to SMB shares exposed by Isilon file system.' type: object title: Isilon SMB Mount Point. properties: accessZoneId: description: Specifies the Access Zone Id. type: - integer - 'null' format: int64 x-go-name: AccessZoneId description: description: Specifies the description of the NFS mount point. type: - string - 'null' x-go-name: Description shareName: description: Specifies the name of the SMB/CIFS share. type: - string - 'null' x-go-name: ShareName x-go-package: cohesity/iris/server/data/public OutlookFolder: description: Specifies the Outlook folder details. type: object title: Outlook Folder. properties: folderId: description: Specifies the unique ID of the folder. type: - string - 'null' x-go-name: FolderId folderKey: description: Specifies the key unique within the mailbox of the folder. type: - integer - 'null' format: int64 x-go-name: FolderKey outlookItemIdList: description: 'Specifies the outlook items within the folder to be restored incase the user wishes not to restore the entire folder.' type: - array - 'null' items: type: string x-go-name: OutlookItemIdList restoreEntireFolder: description: Specifies whether the entire folder is to be restored. type: - boolean - 'null' x-go-name: RestoreEntireFolder x-go-package: cohesity/iris/server/data/public DeviceTreeDetails: description: 'Specifies a logical volume stored as a tree where the leaves are the blocks of partitions and intermediate nodes are assembled by combining nodes using one of the following modes: 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 title: Device Tree. properties: combineMethod: description: 'Specifies how to combine the children of this node. The combining strategy for child devices. Some of these strategies imply constraint on the number of child devices. e.g. RAID5 will have 5 children. ''LINEAR'' indicates children are juxtaposed to form this device. ''STRIPE'' indicates children are striped. ''MIRROR'' indicates children are mirrored. ''RAID5'' ''RAID6'' ''ZERO'' ''THIN'' ''THINPOOL'' ''SNAPSHOT'' ''CACHE'' ''CACHEPOOL''' type: - string - 'null' enum: - LINEAR - STRIPE - MIRROR - RAID5 - RAID6 - ZERO - THIN - THINPOOL - SNAPSHOT - CACHE - CACHEPOOL x-go-name: CombineMethod deviceLength: description: 'Specifies the length of this device. This number should match the length that is calculated from the children and combining method.' type: - integer - 'null' format: int64 x-go-name: DeviceLength deviceNodes: description: Specifies the children of this node in the device tree. type: - array - 'null' items: $ref: '#/components/schemas/DeviceNode' x-go-name: DeviceNodes stripeSize: description: Specifies the size of the striped data if the data is striped. type: - integer - 'null' format: int32 x-go-name: StripeSize x-go-package: cohesity/iris/server/data/public ViewProtectionSource: description: Specifies a Protection Source in a View environment. type: object title: View Protection Source. properties: id: description: 'Specifies a unique id of a Protection Source for a View. The id is unique across Cohesity Clusters.' allOf: - $ref: '#/components/schemas/UniversalId' name: description: Specifies a human readable name of the Protection Source of a View. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of managed Object in a View Protection Source environment. Examples of View Objects include ''kViewBox'' or ''kView''. ''kViewBox'' indicates Storage Domain as a Protection Source type. ''kView'' indicates View as a Protection Source type.' type: - string - 'null' enum: - kViewBox - kView x-go-name: Type x-go-package: cohesity/iris/server/data/public VirtualDiskMapping: description: 'Specifies the request data struct for virtual disk mapping with only the disk ids.' type: object title: Virtual Disk Mapping. properties: diskToOverwrite: description: 'Specifies information about disk which user wants to overwrite. If specified, then powerOffVmBeforeRecovery must be true.' $ref: '#/components/schemas/VirtualDiskIdInformation' sourceDisk: description: Specifies information about the source disk. $ref: '#/components/schemas/VirtualDiskIdInformation' targetLocationId: description: 'Specifies the target location information, for e.g. a datastore in VMware environment. If diskToOverwrite is specified, then the target location is automatically deduced.' type: - integer - 'null' format: int64 x-go-name: TargetLocationId x-go-package: cohesity/iris/server/data/public ProtectionSource: description: 'Specifies a generic structure that represents a node in the Protection Source tree. Node details will depend on the environment of the Protection Source.' type: object title: Protection Source. properties: acropolisProtectionSource: description: 'Specifies details about an Acropolis Protection Source when the environment is set to ''kAcropolis''.' allOf: - $ref: '#/components/schemas/AcropolisProtectionSource' adProtectionSource: description: 'Specifies details about an AD Protection Source when the environment is set to ''kAD''.' allOf: - $ref: '#/components/schemas/AdProtectionSource' awsProtectionSource: description: 'Specifies details about an AWS Protection Source when the environment is set to ''kAWS''.' allOf: - $ref: '#/components/schemas/AwsProtectionSource' azureProtectionSource: description: 'Specifies details about an Azure Protection Source when the environment is set to ''kAzure''.' allOf: - $ref: '#/components/schemas/AzureProtectionSource' cassandraProtectionSource: description: 'Specifies details about a Cassandra Protection Source when the environment is set to ''kCassandra''.' allOf: - $ref: '#/components/schemas/CassandraProtectionSource' couchbaseProtectionSource: description: 'Specifies details about a Couchbase Protection Source when the environment is set to ''kCouchbase''.' allOf: - $ref: '#/components/schemas/CouchbaseProtectionSource' elastifileProtectionSource: description: 'Specifies details about a Elastifile Protection Source when the environment is set to ''kElastifile''.' allOf: - $ref: '#/components/schemas/ElastifileProtectionSource' environment: description: 'Specifies the environment (such as ''kVMware'' or ''kSQL'') where the Protection Source exists. Depending on the environment, one of the following Protection Sources are initialized. NOTE: kPuppeteer refers to Cohesity''s Remote Adapter. 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 exchangeProtectionSource: description: 'Specifies details about an Exchange Protection Source when the environment is set to ''kExchange''.' allOf: - $ref: '#/components/schemas/ExchangeProtectionSource' flashBladeProtectionSource: description: 'Specifies details about a Pure Storage FlashBlade Protection Source when the environment is set to ''kFlashBlade''.' allOf: - $ref: '#/components/schemas/FlashBladeProtectionSource' gcpProtectionSource: description: 'Specifies details about an GCP Protection Source when the environment is set to ''kGCP''.' allOf: - $ref: '#/components/schemas/GcpProtectionSource' gpfsProtectionSource: description: 'Specifies details about an GPFS Protection Source when the environment is set to ''kGPFS''.' allOf: - $ref: '#/components/schemas/GpfsProtectionSource' hbaseProtectionSource: description: 'Specifies details about a HBase Protection Source when the environment is set to ''kHBase''.' allOf: - $ref: '#/components/schemas/HBaseProtectionSource' hdfsProtectionSource: description: 'Specifies details about a Hdfs Protection Source when the environment is set to ''kHdfs''.' allOf: - $ref: '#/components/schemas/HdfsProtectionSource' hiveProtectionSource: description: 'Specifies details about a Hive Protection Source when the environment is set to ''kHive''.' allOf: - $ref: '#/components/schemas/HiveProtectionSource' hyperFlexProtectionSource: description: 'Specifies details about a HyperFlex Storage Snapshot source when the environment is set to ''kHyperFlex''' allOf: - $ref: '#/components/schemas/HyperFlexProtectionSource' hypervProtectionSource: description: 'Specifies details about a HyperV Protection Source when the environment is set to ''kHyperV''.' allOf: - $ref: '#/components/schemas/HypervProtectionSource' id: description: Specifies an id of the Protection Source. type: - integer - 'null' format: int64 x-go-name: Id isilonProtectionSource: description: 'Specifies details about an Isilon OneFs Protection Source when the environment is set to ''kIsilon''.' allOf: - $ref: '#/components/schemas/IsilonProtectionSource' kubernetesProtectionSource: description: 'Specifies details about a Kubernetes Protection Source when the environment is set to ''kKubernetes''.' allOf: - $ref: '#/components/schemas/KubernetesProtectionSource' kvmProtectionSource: description: 'Specifies details about a KVM Protection Source when the environment is set to ''kKVM''.' allOf: - $ref: '#/components/schemas/KvmProtectionSource' mongodbProtectionSource: description: 'Specifies details about a MongoDB Protection Source when the environment is set to ''kMongoDB''.' allOf: - $ref: '#/components/schemas/MongoDBProtectionSource' name: description: Specifies a name of the Protection Source. type: - string - 'null' x-go-name: Name nasProtectionSource: description: 'Specifies details about a Generic NAS Protection Source when the environment is set to ''kGenericNas''.' allOf: - $ref: '#/components/schemas/NasProtectionSource' netappProtectionSource: description: 'Specifies details about a NetApp Protection Source when the environment is set to ''kNetapp''.' allOf: - $ref: '#/components/schemas/NetappProtectionSource' nimbleProtectionSource: description: 'Specifies details about a SAN Protection Source when the environment is set to ''kNimble''.' allOf: - $ref: '#/components/schemas/NimbleProtectionSource' office365ProtectionSource: description: 'Specifies details about an Office 365 Protection Source when the environment is set to ''kO365''.' allOf: - $ref: '#/components/schemas/Office365ProtectionSource' oracleProtectionSource: description: 'Specifies details about an Oracle Protection Source when the environment is set to ''kOracle''.' allOf: - $ref: '#/components/schemas/OracleProtectionSource' parentId: description: Specifies an id of the parent of the Protection Source. type: - integer - 'null' format: int64 x-go-name: ParentId physicalProtectionSource: description: 'Specifies details about a Physical Protection Source when the environment is set to ''kPhysical''.' allOf: - $ref: '#/components/schemas/PhysicalProtectionSource' pureProtectionSource: description: 'Specifies details about a Pure Protection Source when the environment is set to ''kPure''.' allOf: - $ref: '#/components/schemas/PureProtectionSource' sqlProtectionSource: description: 'Specifies details about a SQL Protection Source when the environment is set to ''kSQL''.' allOf: - $ref: '#/components/schemas/SqlProtectionSource' viewProtectionSource: description: 'Specifies details about a View Protection Source when the environment is set to ''kView''.' allOf: - $ref: '#/components/schemas/ViewProtectionSource' vmWareProtectionSource: description: 'Specifies details about a VMware Protection Source when the environment is set to ''kVMware''.' allOf: - $ref: '#/components/schemas/VMwareProtectionSource' x-go-package: cohesity/iris/server/data/public CifsShareInfo: description: Specifies information about a CIFS share of a NetApp volume. type: object title: CIFS Share Information. properties: acls: description: 'Array of Access Control Lists. Specifies the ACLs for this share.' type: - array - 'null' items: type: string x-go-name: Acls name: description: 'Specifies the name of the CIFS share. This can be different from the volume name that this share belongs to. A single volume can export multiple CIFS shares, each with unique settings such as permissions.' type: - string - 'null' x-go-name: Name path: description: Specifies the path of this share under the Vserver's root. type: - string - 'null' x-go-name: Path serverName: description: 'Specifies the CIFS server name (such as ''NETAPP-01'') specified by the system administrator. This name is searchable within the active directory domain.' type: - string - 'null' x-go-name: ServerName x-go-package: cohesity/iris/server/data/public MongoDBCluster: description: Specifies an Object containing information about a mongodb cluster. type: object title: MongoDB Cluster Info. properties: seeds: description: Seeds of this MongoDB Cluster. type: - array - 'null' items: type: string x-go-name: Seeds x-go-package: cohesity/iris/server/data/public 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 MongoDBProtectionSource: description: Specifies an Object representing MongoDB. type: object title: MongoDB Protection Source. properties: clusterInfo: description: 'Information of a mongodb cluster, only valid for an entity of type kCluster.' $ref: '#/components/schemas/MongoDBCluster' collectionInfo: description: 'Information about a mongodb collection, only valid for an entity of type kCollection.' $ref: '#/components/schemas/MongoDBCollection' databaseInfo: description: 'Information of a mongodb database, only valid for an entity of type kDatabase.' $ref: '#/components/schemas/MongoDBDatabase' name: description: Specifies the instance name of the MongoDB entity. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of the managed Object in MongoDB Protection Source. Specifies the type of an MongoDB source entity. ''kCluster'' indicates a mongodb cluster distributed over several physical nodes. ''kDatabase'' indicates a Database within the MongoDB environment. ''kCollection'' indicates a Collection in the MongoDB enironment.' type: - string - 'null' enum: - kCluster - kDatabase - kCollection x-go-name: Type uuid: description: Specifies the UUID for the MongoDB entity. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public SqlRestoreParameters: description: Specifies the parameters specific the Application Server instance. type: object title: SQL Application Server Restore Parameters. properties: captureTailLogs: description: 'Set this 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 hosting Protection Source, and the database is not being renamed.' type: - boolean - 'null' x-go-name: CaptureTailLogs isAutoSyncEnabled: description: 'This field determines if Auto Sync enabled/disabled for SQL Multi-stage Restore task' type: - boolean - 'null' x-go-name: IsAutoSyncEnabled keepCdc: description: 'This field prevents "change data capture" settings from being reomved when a database or log backup is restored on another server and database is recovered.' type: - boolean - 'null' x-go-name: KeepCdc keepOffline: description: 'Set this to true if we want to restore the database and do not want to bring it online after restore. This is only applicable if we are restoring the database back to its original location.' type: - boolean - 'null' x-go-name: KeepOffline newDatabaseName: description: Specifies optionally a new name for the restored database. type: - string - 'null' x-go-name: NewDatabaseName newInstanceName: description: 'Specifies an instance name of the SQL Server that should be restored. SQL application has many instances. Each instance has a unique name. One of the instances that should be restored must be set in this field.' type: - string - 'null' x-go-name: NewInstanceName restoreTimeSecs: description: 'Specifies the time in the past 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 restored from the full/incremental snapshot.' type: - integer - 'null' format: int64 x-go-name: RestoreTimeSecs targetDataFilesDirectory: description: 'Specifies the directory where to put the database data files. Missing directory will be automatically created. This field must be set if restoring to a different target host.' type: - string - 'null' x-go-name: TargetDataFilesDirectory targetLogFilesDirectory: description: 'Specifies the directory where to put the database log files. Missing directory will be automatically created. This field must be set if restoring to a different target host.' type: - string - 'null' x-go-name: TargetLogFilesDirectory targetSecondaryDataFilesDirectoryList: description: 'Specifies the secondary data filename pattern and corresponding directories 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/FilenamePatternToDirectory' x-go-name: TargetSecondaryDataFilesDirectoryList withClause: description: 'WithClause allows you to specify clauses to be used in native sql restore task.' type: - string - 'null' x-go-name: WithClause x-go-package: cohesity/iris/server/data/public OracleSession: description: Specifies information about session configuration for an Oracle host. type: object title: Oracle Session. properties: location: description: Location is the path where Oracle is installed. type: - string - 'null' x-go-name: Location systemIdentifier: description: 'SystemIdentifier is the unique Oracle System Identifier for the DB instance.' type: - string - 'null' x-go-name: SystemIdentifier x-go-package: cohesity/iris/server/data/public AdDomainController: description: Specifies information about an AD domain controller. type: object title: AD Domain Controller. properties: backupSupported: description: Specifies whether backup of this domain controller is supported. type: - boolean - 'null' x-go-name: BackupSupported backupUnsupportedReasons: description: Specifies any reason(s) for domain controller backup not supported. type: - array - 'null' items: type: string x-go-name: BackupUnsupportedReasons domain: description: Specifies Domain hosted on this domain controller. $ref: '#/components/schemas/AdDomain' hostName: description: Specifies FQDN host name of the domain controller. type: - string - 'null' x-go-name: HostName isGlobalCatalog: description: Specifies whether this domain controller is a global catalog server. type: - boolean - 'null' x-go-name: IsGlobalCatalog isReadOnly: description: Specifies whether this domain controller is read only. type: - boolean - 'null' x-go-name: IsReadOnly utcOffsetMin: description: Specifies UTC time offset of this domain controller in minutes. type: - integer - 'null' format: int32 x-go-name: UtcOffsetMin x-go-package: cohesity/iris/server/data/public GcpProtectionSource: description: Specifies a Protection Source in GCP environment. type: object title: GCP Protection Source. properties: clientEmailAddress: description: Specifies Client email address associated with the service account. type: - string - 'null' x-go-name: ClientEmailAddress clientPrivateKey: description: Specifies Client private associated with the service account. type: - string - 'null' x-go-name: ClientPrivateKey gcpType: description: 'Specifies the entity type such as ''kIAMUser'' if the environment is kGCP. Specifies the type of a GCP source entity. ''kIAMUser'' indicates a unique user within a GCP account. ''kProject'' represents compute resources and storage. ''kRegion'' indicates a geographical region in the global infrastructure. ''kAvailabilityZone'' indicates an availability zone within a region. ''kVirtualMachine'' indicates a Virtual Machine running in GCP environment. ''kVPC'' indicates a virtual private cloud (VPC) network within GCP. ''kSubnet'' indicates a subnet inside the VPC. ''kNetworkSecurityGroup'' represents a network security group. ''kInstanceType'' represents various machine types. ''kLabel'' represents a label present on the instances. ''kMetaData'' represents a custom metadata present on instances. ''kTag'' represents a network tag on instances. ''kVPCConnector'' represents a VPC connector used for serverless VPC access.' type: - string - 'null' enum: - kIAMUser - kProject - kRegion - kAvailabilityZone - kVirtualMachine - kVPC - kSubnet - kNetworkSecurityGroup - kInstanceType - kLabel - kMetadata - kTag - kVPCConnector x-go-name: GcpType hostProjectId: description: 'Specifies the host project id. It is populated in entities of type kSubnet if the subnet is part of a shared VPC. This contains the ID of host project the subnet belongs to. Populated in entities of type kProject if the project is a service project in a Shared VPC setup. This contains the ID of the host project it is attached to.' type: - string - 'null' x-go-name: HostProjectId hostType: description: 'Specifies the OS type of the Protection Source of type ''kVirtualMachine'' such as ''kWindows'' or ''kLinux''. overrideDescription: true ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: HostType ipAddressesVM: description: Specifies the IP address of the entity of type 'kVirtualMachine'. type: - string - 'null' x-go-name: IpAddressVM name: description: 'Specifies the name of the Object set by the Cloud Provider. If the provider did not set a name for the object, this field is not set.' type: - string - 'null' x-go-name: Name ownerId: description: 'Specifies the owner id of the resource in GCP environment. With type, name and ownerId gives a globally unique identity to the GCP entity.' type: - string - 'null' x-go-name: OwnerId physicalSourceId: description: 'Specifies the Protection Source id of the registered Physical Host. If the cloud entity is protected using a Physical Agent, it must be registered as a physical host.' type: - integer - 'null' format: int64 x-go-name: PhysicalSourceId projectId: description: 'Specifies the project Id. For the kIAMUser entity this contains the id of the project to be used to deploy proxy VMs. For entities of type kVirtualMachine this contains the id of the project the virtual machine belongs to.' type: - string - 'null' x-go-name: ProjectId regionId: description: 'Specifies the region Id. For the kIAMUser entity this contains the region to be used to deploy proxy VMs. For entities of type kVirtualMachine this contains the region the virtual machine belongs to.' type: - string - 'null' x-go-name: RegionId resourceId: description: Specifies the unique Id of the resource given by the cloud provider. type: - string - 'null' x-go-name: ResourceId restoreTaskId: description: 'Specifies the id of the "convert and deploy" restore task that created the entity in the cloud. It is required to support the DR-to-cloud usecase where we replicate an on-prem entity to a cluster running in cloud, bring it up using "convert and deploy" mechanism, protect it using a cloud job that uses physical adapter, and convert it back to the on-prem format before replication. Before replicating, we need to update the backup task state of the backed up entity using the on-prem entity and on-prem entity''s parent. The id is used to lookup the restore entity that contains details about the on-prem entity. It is set at the time of refreshing the cloud entity hierarchy if all the following conditions are met: Name of the current entity matches with name of any cloud entity deployed using the "convert and deploy" restore task. Restore entity associated with the above matched cloud entity has ''failed_over'' flag set to true in its cloud extension.' type: - integer - 'null' format: int64 x-go-name: RestoreTaskId tagAttributes: description: Specifies the list of GCP tag attributes. type: - array - 'null' items: $ref: '#/components/schemas/TagAttribute' x-go-name: TagAttributes type: description: 'Specifies the type of an GCP Protection Source Object such as ''kIAMUser'', ''kProject'', ''kRegion'', etc. Specifies the type of a GCP source entity. ''kIAMUser'' indicates a unique user within a GCP account. ''kProject'' represents compute resources and storage. ''kRegion'' indicates a geographical region in the global infrastructure. ''kAvailabilityZone'' indicates an availability zone within a region. ''kVirtualMachine'' indicates a Virtual Machine running in GCP environment. ''kVPC'' indicates a virtual private cloud (VPC) network within GCP. ''kSubnet'' indicates a subnet inside the VPC. ''kNetworkSecurityGroup'' represents a network security group. ''kInstanceType'' represents various machine types. ''kLabel'' represents a label present on the instances. ''kMetaData'' represents a custom metadata present on instances. ''kTag'' represents a network tag on instances. ''kVPCConnector'' represents a VPC connector used for serverless VPC access.' type: - string - 'null' enum: - kIAMUser - kProject - kRegion - kAvailabilityZone - kVirtualMachine - kVPC - kSubnet - kNetworkSecurityGroup - kInstanceType - kLabel - kMetadata - kTag - kVPCConnector x-go-name: Type vpcNetwork: description: Specifies the VPC Network to deploy proxy VMs. type: - string - 'null' x-go-name: VpcNetwork vpcSubnetwork: description: Specifies the subnetwork to deploy proxy VMs. type: - string - 'null' x-go-name: VpcSubnetwork x-go-package: cohesity/iris/server/data/public OutlookRestoreParameters: description: 'Specifies information needed for recovering Mailboxes in O365Outlook environment.' type: object title: Outlook Restore Parameters. properties: outlookMailboxList: description: Specifies the list of mailboxes to be restored. type: - array - 'null' items: $ref: '#/components/schemas/OutlookMailbox' x-go-name: OutlookMailboxList targetFolderPath: description: 'Specifies the target folder path to restore the mailboxes. This will always be specified whether the target mailbox is the original or an alternate one.' type: - string - 'null' x-go-name: TargetFolderPath targetMailbox: description: 'Specifies the destination mailbox where the mailboxes specified within OutlookMailboxes will be restored with their appropriate names.' $ref: '#/components/schemas/ProtectionSource' x-go-package: cohesity/iris/server/data/public AdObjectRestoreInformation: description: Represents the details about the restore of the AD object. type: object title: AD Object Restore Information. properties: attributeRestoreInfo: description: Specifies the list of attributes of the AD object whose restore failed. type: - array - 'null' items: $ref: '#/components/schemas/AttributeRestoreInformation' x-go-name: AttributeRestoreInfo errorMessage: description: Specifies the error message while restoring the AD Object. type: - string - 'null' x-go-name: ErrorMessage name: description: Specifies the name of the AD object. type: - string - 'null' x-go-name: Name startTimeUsecs: description: 'Specifies the start time of the restore of the AD object specified as a Unix epoch Timestamp(in microseconds).' type: - integer - 'null' format: int64 x-go-name: StartTimeUsecs timeTakenMsecs: description: 'Specifies the time taken for restore of AD Object and its attributes in milliseconds.' type: - integer - 'null' format: uint64 x-go-name: TimeTakenMsecs x-go-package: cohesity/iris/server/data/public AttributeValue: description: Represents the information about the values of attribute of the ADObject. type: object title: AttributeValue properties: flags: description: 'Specifies the flags related to the attribute values of the AD object. ''kError'' indicates error in conversion of AD Object value to string. The value in the AdAttributValue contains the error message. ''kTruncated'' indicates the multi valued attribute is truncated when value exceeded ''truncate_multivalues'' value specified in the request. ''kCSV'' indicates content in ''values'' is a comma separated value (CSV) format of a complex object.' type: - array - 'null' items: type: string enum: - kError - kTruncated - kCSV x-go-name: AttributeValFlags values: description: Specifies list of values for the attribute. type: - array - 'null' items: type: string x-go-name: Values x-go-package: cohesity/iris/server/data/public MountVolumesParameters: description: 'Specifies the information required for mounting volumes. Only required for Restore Tasks of type ''kMountVolumes''. At a minimum, the targetSourceId must be specified for ''kMountVolumes'' Restore Tasks. If only targetSourceId is specified, all disks are attached but may not be mounted. The mount target must be registered on the Cohesity Cluster. If the mount target is a VM, VMware Tools must be installed. If the mount target is a physical server, a Cohesity Agent must be be installed. See the Cohesity Dashboard help documentation for details. In the username and password fields, specify the credentials to access the mount target.' type: object title: Mounting Volumes. properties: bringDisksOnline: description: 'Optional setting that determines if the volumes are brought online on the mount target after attaching the disks. This field is only set for VMs. The Cohesity Cluster always attempts to mount Physical servers. If true and the mount target is a VM, to mount the volumes VMware Tools must be installed on the guest operating system of the VM and login credentials to the mount target must be specified. NOTE: If automount is configured for a Windows system, the volumes may be automatically brought online.' type: - boolean - 'null' x-go-name: BringDisksOnline password: description: Specifies password of the username to access the target source. type: - string - 'null' x-go-name: Password targetSourceId: description: 'Specifies the target Protection Source id where the volumes will be mounted. NOTE: The source that was backed up and the mount target must be the same type, for example if the source is a VMware VM, then the mount target must also be a VMware VM. The mount target must be registered on the Cohesity Cluster.' type: - integer - 'null' format: int64 x-go-name: TargetSourceId useExistingAgent: description: 'Optional setting that determines if this will use an existing agent on the target vm to bring disks online.' type: - boolean - 'null' x-go-name: UseExistingAgent username: description: Specifies username to access the target source. type: - string - 'null' x-go-name: Username volumeNames: description: 'Array of Volume Names. Optionally specify the names of volumes to mount. If none are specified, all volumes of the Server are mounted on the target. To get the names of the volumes, call the GET /public/restore/vms/volumesInformation operation.' type: - array - 'null' items: type: string x-go-name: VolumeNames x-go-package: cohesity/iris/server/data/public ExchangeRestoreViewParameters: type: object properties: endpoint: description: 'Specifies whether we should white-list the restore view for all the IP addresses. If this parameter is set to false, then only the machine on which the view is mounted will be white-listed.' type: - boolean - 'null' x-go-name: WhitelistRestoreViewForAll mountPoint: description: Specifies the path of the SMB share. type: - string - 'null' x-go-name: MountPoint viewName: description: 'Specifies the view to which the files of an Exchange database has to be cloned.' type: - string - 'null' x-go-name: ViewName x-go-package: cohesity/iris/server/data/public FileFstatResult: description: FileFstatResult is the struct to return the result of file Fstats. type: object title: File Fstat Result. properties: cookie: description: 'Cookie is used for paginating results. If ReadVMDirResult is returning partial results, this field will be set. Supplying this cookie will resume listing from where this result left off.' type: - integer - 'null' format: uint64 x-go-name: Cookie fstatInfo: description: FstatInfo is the stat information for the file. $ref: '#/components/schemas/FileStatInfo' x-go-package: cohesity/iris/server/data/public CloneTaskRequest: description: Specifies the settings for a Restore Task that clones VMs or Views. type: object title: Clone Restore Task Request. required: - name - type properties: cloneViewParameters: description: 'Specifies settings for cloning an existing View. This field is required for a ''kCloneView'' Restore Task.' title: Clone View. allOf: - $ref: '#/components/schemas/CloneViewRequest' 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 glacierRetrievalType: description: 'Specifies the way data needs to be retrieved from the external target. This information will be filled in by Iris and Magneto will pass it along to the Icebox as it is to support bulk retrieval from Glacier. Specifies the type of Restore Task. ''kStandard'' specifies retrievals that allow to access any of your archives within several hours. Standard retrievals typically complete within 3–5 hours. This is the default option for retrieval requests that do not specify the retrieval option. ''kBulk'' specifies retrievals that are Glacier’s lowest-cost retrieval option, which can be used to retrieve large amounts, even petabytes, of data inexpensively in a day. Bulk retrieval typically complete within 5–12 hours. ''kExpedited'' specifies retrievals that allows to quickly access your data when occasional urgent requests for a subset of archives are required. For all but the largest archives (250 MB+), data accessed using Expedited retrievals are typically made available within 1–5 minutes.' type: - string - 'null' enum: - kStandard - kBulk - kExpedited x-go-name: GlacierRetrievalType hypervParameters: description: Specifies additional parameters for 'kHyperV' restore objects. $ref: '#/components/schemas/HypervCloneParameters' 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 targetViewName: description: 'Specifies the name of the View where the cloned VMs are stored. This field is required for a ''kCloneVMs'' Restore Task.' type: - string - 'null' x-go-name: TargetViewName type: description: 'Specifies the type of Restore Task such as ''kCloneVMs'' or ''kCloneView''. ''kCloneVMs'' specifies a Restore Task that clones VMs. ''kCloneView'' specifies a Restore Task that clones a View.' type: - string - 'null' enum: - kCloneVMs - kCloneView x-go-name: Type vlanParameters: description: Specifies VLAN parameters for the restore operation. $ref: '#/components/schemas/VlanParameters' vmwareParameters: description: Specifies additional parameters for 'kVmware' restore objects. $ref: '#/components/schemas/VmwareCloneParameters' x-go-package: cohesity/iris/server/data/public FileVersion: description: Specifies information about a single file or folder. type: object title: File/Folder Version. properties: modifiedTimeUsecs: description: 'Specifies the time when the file or folder was last modified. Specified as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: ModifiedTimeUsecs sizeBytes: description: 'Specifies the size of the file or folder (in bytes) from the most recent snapshot.' type: - integer - 'null' format: int64 x-go-name: SizeBytes snapshots: description: 'Array of Snapshots. Specifies the available snapshots of the file or folder. When a Job Run executes, it captures a snapshot of object (such as a VM) that contains the file or folder.' type: - array - 'null' items: $ref: '#/components/schemas/SnapshotAttempt' x-go-name: Snapshots x-go-package: cohesity/iris/server/data/public AdGuidPair: description: AdGuidPair is the AD object guid string pair. type: object title: 'Refer: ADGuidPair /magneto/agents/windows/stub/ad_param.proto AD GUID Pair' properties: destination: description: 'Specifies the 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: 'Specifies the 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: cohesity/iris/server/data/public Subnet: description: 'Defines a Subnet (Subnetwork). The netmask can be specified by setting netmaskBits or netmaskIp4. The netmask can only be set using netmaskIp4 if the IP address is an IPv4 address.' type: object title: Subnet properties: component: description: Component that has reserved the subnet. type: - string - 'null' x-go-name: Component description: description: Description of the subnet. type: - string - 'null' x-go-name: Description id: description: ID of the subnet. type: - integer - 'null' format: int32 x-go-name: Id ip: description: Specifies either an IPv6 address or an IPv4 address. type: - string - 'null' x-go-name: Ip netmaskBits: description: Specifies the netmask using bits. type: - integer - 'null' format: int32 x-go-name: NetmaskBits netmaskIp4: description: 'Specifies the netmask using an IP4 address. The netmask can only be set using netmaskIp4 if the IP address is an IPv4 address.' type: - string - 'null' x-go-name: NetmaskIp4 nfsAccess: description: 'Specifies whether clients from this subnet can mount using NFS protocol. Protocol access level. ''kDisabled'' indicates Protocol access level ''Disabled'' ''kReadOnly'' indicates Protocol access level ''ReadOnly'' ''kReadWrite'' indicates Protocol access level ''ReadWrite''' type: - string - 'null' enum: - kDisabled - kReadOnly - kReadWrite x-go-name: NfsAccess nfsAllSquash: description: 'Specifies 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: Specifies whether clients from this subnet can mount as root on NFS. type: - boolean - 'null' x-go-name: NfsRootSquash smbAccess: description: 'Specifies whether clients from this subnet can mount using SMB protocol. Protocol access level. ''kDisabled'' indicates Protocol access level ''Disabled'' ''kReadOnly'' indicates Protocol access level ''ReadOnly'' ''kReadWrite'' indicates Protocol access level ''ReadWrite''' type: - string - 'null' enum: - kDisabled - kReadOnly - kReadWrite x-go-name: SmbAccess x-go-package: cohesity/iris/server/data/public GpfsCluster: description: Specifies information about a GPFS Cluster. type: object title: GPFS Cluster. properties: cesAddresses: description: 'Specifies a list of CES(Cluster Export Services) IP addresses of a GPFS Cluster.' type: - array - 'null' items: type: string x-go-name: CesAddresses id: description: Specifies a globally unique id of a GPFS Cluster. type: - integer - 'null' format: uint64 x-go-name: Id primaryServer: description: Specifies a primary server of a GPFS Cluster. type: - string - 'null' x-go-name: PrimaryServer x-go-package: cohesity/iris/server/data/public HyperFlexProtectionSource: description: Specifies a Storage Snapshot Provider in a HyperFlex environment. type: object title: HyperFlex Storae Snapshot. properties: name: description: Specifies a unique name of the Protection Source type: - string - 'null' x-go-name: Name productVersion: description: Specifies the product version of the protection source. type: - string - 'null' x-go-name: ProductVersion type: description: 'Specifies the type of managed Object in a HyperFlex protection source like kServer. Examples of a HyperFlex types include ''kServer''. ''kServer'' indicates HyperFlex server entity.' type: - string - 'null' enum: - kServer x-go-name: Type uuid: description: Specifies the uuid of the protection source. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public AdRestoreOptions: description: 'AdRestoreOptions are the AD specific options for the restore task being updated' type: object title: AD Restore Options properties: objectAttributeParameters: description: 'Specifies the object attributes restore parameters with the list of attributes to be restored. This is set only when type is kObjectAttributes.' $ref: '#/components/schemas/AdObjectAttributeParameters' objectParameters: description: 'Specifies the object restore params with info about objects to be restored. This is set only when type is kObjects.' $ref: '#/components/schemas/AdObjectRestoreParameters' type: description: 'Specifies the AD restore request type. Specifies the action type of AD restore. ''kNone'' specifies no special behaviour. ''kObjects'' specifies the user action to restore AD objects from a mounted AD snapshot database. ''kObjectAttributes'' specifies the user action to restore attributes of an AD object from a mounted AD snapshot database.' type: - string - 'null' enum: - kNone - kObjects - kObjectAttributes x-go-name: Type x-go-package: cohesity/iris/server/data/public PhysicalVolume: description: Specifies volume information about a Physical Protection Source. type: object title: Physical Volume. properties: devicePath: description: Specifies the path to the device that hosts the volume locally. type: - string - 'null' x-go-name: DevicePath guid: description: Specifies an id for the Physical Volume. type: - string - 'null' x-go-name: Guid isBootVolume: description: Specifies whether the volume is boot volume. type: - boolean - 'null' x-go-name: IsBootVolume isExtendedAttributesSupported: description: 'Specifies whether this volume supports extended attributes (like ACLs) when performing file backups.' type: - boolean - 'null' x-go-name: IsExtendedAttributesSupported isProtected: description: Specifies if a volume is protected by a Job. type: - boolean - 'null' x-go-name: IsProtected isSharedVolume: description: Specifies whether the volume is shared volume. type: - boolean - 'null' x-go-name: IsSharedVolume label: description: 'Specifies a volume label that can be used for displaying additional identifying information about a volume.' type: - string - 'null' x-go-name: Label logicalSizeBytes: description: 'Specifies the logical size of the volume in bytes that is not reduced by change-block tracking, compression and deduplication.' type: - integer - 'null' format: uint64 x-go-name: LogicalSizeBytes mountPoints: description: 'Array of Mount Points. Specifies the mount points where the volume is mounted, for example: ''C:\'', ''/mnt/foo'' etc.' type: - array - 'null' items: type: string x-go-name: MountPoints mountType: description: Specifies mount type of volume e.g. nfs, autofs, ext4 etc. type: - string - 'null' x-go-name: MountType networkPath: description: 'Specifies the full path to connect to the network attached volume. For example, (IP or hostname):/path/to/share for NFS volumes).' type: - string - 'null' x-go-name: NetworkPath usedSizeBytes: description: Specifies the size used by the volume in bytes. type: - integer - 'null' format: uint64 x-go-name: UsedSizeBytes x-go-package: cohesity/iris/server/data/public SmbPermission: description: Specifies information about a single SMB permission. type: object title: SMB Permission. properties: access: description: 'Specifies the read/write access to the SMB share. ''kReadyOnly'' indicates read only access to the SMB share. ''kReadWrite'' indicates read and write access to the SMB share. ''kFullControl'' indicates full administrative control of the SMB share. ''kSpecialAccess'' indicates custom permissions to the SMB share using access masks structures. ''kSuperUser'' indicates root permissions ignoring all SMB ACLs.' type: - string - 'null' enum: - kReadOnly - kReadWrite - kModify - kFullControl - kSpecialAccess - kSuperUser x-go-name: Access mode: description: 'Specifies how the permission should be applied to folders and/or files. ''kFolderSubFoldersAndFiles'' indicates that permissions are applied to a Folder and it''s sub folders and files. ''kFolderAndSubFolders'' indicates that permissions are applied to a Folder and it''s sub folders. ''kFolderAndSubFiles'' indicates that permissions are applied to a Folder and it''s sub files. ''kFolderOnly'' indicates that permsission are applied to folder only. ''kSubFoldersAndFilesOnly'' indicates that permissions are applied to sub folders and files only. ''kSubFoldersOnly'' indicates that permissiona are applied to sub folders only. ''kFilesOnly'' indicates that permissions are applied to files only.' type: - string - 'null' enum: - kFolderSubFoldersAndFiles - kFolderAndSubFolders - kFolderAndFiles - kFolderOnly - kSubFoldersAndFilesOnly - kSubFoldersOnly - kFilesOnly x-go-name: Mode sid: description: Specifies the security identifier (SID) of the principal. type: - string - 'null' x-go-name: Sid specialAccessMask: description: 'Specifies custom access permissions. When the access mask from the Access Control Entry (ACE) cannot be mapped to one of the enums in ''access'', this field is populated with the custom mask derived from the ACE and ''access'' is set to kSpecialAccess. This is a placeholder for storing an unmapped access permission and should not be set when creating and editing a View.' type: - integer - 'null' format: uint32 x-go-name: SpecialAccessMask specialType: description: 'Specifies a custom type. When the type from the Access Control Entry (ACE) cannot be mapped to one of the enums in ''type'', this field is populated with the custom type derived from the ACE and ''type'' is set to kSpecialType. This is a placeholder for storing an unmapped type and should not be set when creating and editing a View.' type: - integer - 'null' format: int32 x-go-name: SpecialType type: description: 'Specifies the type of permission. ''kAllow'' indicates access is allowed. ''kDeny'' indicates access is denied. ''kSpecialType'' indicates a type defined in the Access Control Entry (ACE) does not map to ''kAllow'' or ''kDeny''.' type: - string - 'null' enum: - kAllow - kDeny - kSpecialType x-go-name: Type x-go-package: cohesity/iris/server/data/public NetappProtectionSource: description: Specifies a Protection Source in a NetApp environment. type: object title: NetApp Protection Source. properties: clusterInfo: description: 'Specifies information about a NetApp cluster and is only valid for a NetApp Object of type kCluster.' $ref: '#/components/schemas/NetappClusterInfo' isTopLevel: description: 'Specifies if this Object is a top level Object. Because a top level Object can either be a NetApp cluster or a Vserver, this cannot be determined only by type.' type: - boolean - 'null' x-go-name: IsTopLevel licenseTypes: description: 'Specifies the type of license available on Netapp Cluster ''kSnapmirrorCloud'' indicates a SnapMirror license on Netapp.' type: - array - 'null' items: type: string enum: - kSnapmirrorCloud x-go-name: LicenseTypes name: description: Specifies the name of the NetApp Object. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of managed NetApp Object in a NetApp Protection Source such as ''kCluster'', ''kVserver'' or ''kVolume''. ''kCluster'' indicates a Netapp cluster as a protection source. ''kVserver'' indicates a Netapp vserver in a cluster as a protection source. ''kVolume'' indicates a volume in Netapp vserver as a protection source.' type: - string - 'null' enum: - kCluster - kVserver - kVolume x-go-name: Type uuid: description: 'Specifies the globally unique ID of this Object assigned by the NetApp server.' type: - string - 'null' x-go-name: Uuid version: description: Specifies the version of Netapp Cluster. type: - string - 'null' x-go-name: Version volumeInfo: description: 'Specifies information about a NetApp volume and is only valid for a NetApp Object of type kVolume.' $ref: '#/components/schemas/NetappVolumeInfo' vserverInfo: description: 'Specifies information about a NetApp Vserver and is only valid for a NetApp Object of type kVserver.' $ref: '#/components/schemas/NetappVserverInfo' x-go-package: cohesity/iris/server/data/public OneDriveOwner: description: Specifies OneDrive owner details. type: object title: OneDrive Owner. properties: driveInfoList: description: Specifies the Drives that a user owns which are to be restored. type: - array - 'null' items: $ref: '#/components/schemas/OneDriveInfo' x-go-name: DriveInfoList userDetailObject: description: Specifies the details about the Office365 user who owns the drive. $ref: '#/components/schemas/RestoreObjectDetails' x-go-package: cohesity/iris/server/data/public RegisteredAppInfo: type: object properties: authenticationErrorMessage: description: 'Specifies an authentication error message. This indicates the given credentials are rejected and the registration of the application is not successful.' type: - string - 'null' x-go-name: AuthenticationErrorMessage authenticationStatus: description: 'Specifies the status of authenticating to the Protection Source when registering this application with Cohesity Cluster. If the status is ''kFinished'' and there is no error, registration is successful. Specifies the status of the authentication during the registration of a Protection Source. ''kPending'' indicates the authentication is in progress. ''kScheduled'' indicates the authentication is scheduled. ''kFinished'' indicates the authentication is completed. ''kRefreshInProgress'' indicates the refresh is in progress.' type: - string - 'null' enum: - kPending - kScheduled - kFinished - kRefreshInProgress x-go-name: AuthenticationStatus environment: description: 'Specifies the application environment. 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 hostSettingsCheckResults: description: 'Specifies the list of check results internally performed to verify status of various services such as ''AgnetRunning'', ''SQLWriterRunning'' etc.' type: - array - 'null' items: $ref: '#/components/schemas/HostSettingsCheckResult' x-go-name: HostSettingsCheckResults refreshErrorMessage: description: 'Specifies a message if there was any error encountered during the last rebuild of the application tree. If there was no error during the last rebuild, this field is reset.' type: - string - 'null' x-go-name: RefreshErrorMessage x-go-package: cohesity/iris/server/data/public HypervDatastore: description: Specifies information about a Datastore Object in HyperV environment. type: object title: HyperV Datastore Object. properties: capacity: description: Specifies the capacity of the datastore in bytes. type: - integer - 'null' format: uint64 x-go-name: Capacity freeSpace: description: Specifies the available space on the datastore in bytes. type: - integer - 'null' format: uint64 x-go-name: FreeSpace mountPoints: description: Specifies the available mount points on the datastore. type: - array - 'null' items: type: string x-go-name: MountPoints type: description: 'Specifies the type of the datastore object like kFileShare or kVolume. overrideDescription: true Specifies the type of a HyperV datastore object. ''kFileShare'' indicates SMB file share datastore. ''kVolume'' indicates a volume which can a LUN.' type: - string - 'null' enum: - kFileShare - kVolume x-go-name: Type x-go-package: cohesity/iris/server/data/public DbFileInfo: description: Specifies information about a database file. type: object title: Database File Information. properties: fileType: description: 'Specifies the format type of the file that SQL database stores the data. Specifies the format type of the file that SQL database stores the data. ''kRows'' refers to a data file ''kLog'' refers to a log file ''kFileStream'' refers to a directory containing FILESTREAM data ''kNotSupportedType'' is for information purposes only. Not supported. ''kFullText'' refers to a full-text catalog.' type: - string - 'null' enum: - kRows - kLog - kFileStream - kNotSupportedType - kFullText x-go-name: FileType fullPath: description: Specifies the full path of the database file on the SQL host machine. type: - string - 'null' x-go-name: FullPath sizeBytes: description: Specifies the last known size of the database file. type: - integer - 'null' format: int64 x-go-name: SizeBytes x-go-package: cohesity/iris/server/data/public ApplicationRestoreParameters: description: Specifies the information regarding the application restore parameters. type: object title: Application Restore Parameters. properties: applicationEnvironment: description: 'Specifies the Environment of the Application server to restore like ''kSQL'',''kAD'',or ''kExchange''. 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: ApplicationEnvironment applicationRestoreObjects: description: Specifies the Application Server objects whose data should be restored. type: - array - 'null' items: $ref: '#/components/schemas/ApplicationRestoreObject' x-go-name: ApplicationRestoreObjects hostingProtectionSource: description: 'Specifies the restore information for the Protection Source object that registered and hosts the Application Servers. This provides the snapshot details from which the application should be restored.' $ref: '#/components/schemas/RestoreObjectDetails' protectionSourceAndApplicationObjects: description: 'Specifies the list of hosting protection source and Application restore objects tuple.' type: - array - 'null' items: $ref: '#/components/schemas/ProtectionSourceAndApplicationRestoreObjects' x-go-name: ProtectionSourceAndApplicationObjects x-go-package: cohesity/iris/server/data/public Office365UserInfo: description: Specifies information about an Office365 user. type: object title: Office 365 User Info. properties: city: description: Specifies the city in which the Office365 user is located. type: - string - 'null' x-go-name: City country: description: Specifies the country/region in which the Office365 user is located. type: - string - 'null' x-go-name: Country department: description: Specifies the department within the enterprise of the Office365 user. type: - string - 'null' x-go-name: Department designation: description: Specifies the designation of the Office365 user. type: - string - 'null' x-go-name: Designation graphUuid: description: Specifies the MS Graph UUID for the given user entity. type: - string - 'null' x-go-name: GraphUuid mailboxSize: description: 'Specifies the size of the Outlook Mailbox associated with this Office365 entity.' type: - integer - 'null' format: int64 x-go-name: MailboxSize oneDriveId: description: 'Specifies the Id of the OneDrive associated with the this Office 365 entity.' type: - string - 'null' x-go-name: OneDriveId oneDriveSize: description: Specifies the size of the OneDrive associated with this Office365 entity. type: - integer - 'null' format: int64 x-go-name: OneDriveSize x-go-package: cohesity/iris/server/data/public VserverNetworkInterface: description: 'Specifies information about a logical network interface on a NetApp Vserver. The interface''s IP address is the mount point for a specific data protocol, such as NFS or CIFS.' type: object title: Vserver Network Interface. properties: dataProtocols: description: 'Array of Data Protocols. Specifies the set of data protocols supported by this interface. ''kNfs'' indicates NFS connections. ''kCifs'' indicates SMB (CIFS) connections. ''kIscsi'' indicates iSCSI connections. ''kFc'' indicates Fiber Channel connections. ''kFcache'' indicates Flex Cache connections. ''kHttp'' indicates HTTP connections. ''kNdmp'' indicates NDMP connections. ''kManagement'' indicates non-data connections used for management purposes. ''kNvme'' indicates NVMe connections.' type: - array - 'null' items: type: string enum: - kNfs - kCifs - kIscsi - kFc - kFcache - kHttp - kNdmp - kManagement - kNvme x-go-name: DataProtocols ipAddress: description: Specifies the IP address of this interface. type: - string - 'null' x-go-name: IpAddress name: description: Specifies the name of this interface. type: - string - 'null' x-go-name: Name x-go-package: cohesity/iris/server/data/public AdObjectAttributeParameters: description: 'AdObjectAttributeParameters are AD attribute recovery parameters for one or more AD objects' type: object title: AD Object Attribute Parameters properties: adGuidPairs: description: 'Specifies the array of source and destination object guid pairs to restore attributes.' type: - array - 'null' items: $ref: '#/components/schemas/AdGuidPair' x-go-name: AdGuidPairs excludeLdapProperties: description: 'Specifies the 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: ExcludeLdapProperties ldapProperties: description: 'Specifies the 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.' type: - array - 'null' items: type: string x-go-name: LdapProperties mergeMultiValProperties: description: 'Specifies the Option to merge multi-valued values vs clearing and setting values from the AD snapshot. Defaults is to overwrite production AD values from the source AD snapshot. When updating group membership (using ''memberOf'' property), setting this option to true will result in group membership merge. This is useful in cases where production AD has later updates that should not be overridden while restoring an attribute.' type: - boolean - 'null' x-go-name: MergeMultiValProperties x-go-package: cohesity/iris/server/data/public ObjectSnapshotInfo: description: Specifies information about an object that has been backed up. type: object title: Object Snapshot. properties: clusterPartitionId: description: Specifies the Cohesity Cluster partition id where this object is stored. type: - integer - 'null' format: int64 x-go-name: ClusterPartitionId jobId: description: 'Specifies the id for the Protection Job that is currently associated with the object. If the object was backed up on current Cohesity Cluster, this field contains the id for the Job that captured this backup object. If the object was backed up on a Primary Cluster and replicated to this Cohesity Cluster, a new Inactive Job is created, the object is now associated with new Inactive Job, and this field contains the id of the new Inactive Job.' type: - integer - 'null' format: int64 x-go-name: JobId jobName: description: Specifies the name of the Protection Job that captured the backup. type: - string - 'null' x-go-name: JobName jobUid: description: 'Specifies the globally unique id of the Protection Job that backed up this object. This id is unique across Cohesity Clusters. Even if this object is replicated to a Remote Cohesity Cluster and the object is associated with a new Job, the value specified in this field does not change.' allOf: - $ref: '#/components/schemas/UniversalId' objectName: description: Specifies the primary name of the object. type: - string - 'null' x-go-name: ObjectName osType: description: Specifies the inferred OS type. type: - string - 'null' x-go-name: OsType registeredSource: description: 'Specifies the id of the original root Protection Source tree (such as a vCenter Server) that was accessed by the Protection Job to capture a backup of this object.' $ref: '#/components/schemas/ProtectionSource' snapshottedSource: description: 'Specifies the Protection Source that represents the original object being backed up. When a root Protection Source is registered, it creates a tree of source Protection Source objects. This field defines the specific Protection Source leaf object (such as a VM) that was backed up.' $ref: '#/components/schemas/ProtectionSource' versions: description: 'Array of Snapshots. Specifies all snapshot versions of this object. Each time a Job Run of a Job executes, it may create a new snapshot version of an object. This array stores the different snapshots versions of the object.' type: - array - 'null' items: $ref: '#/components/schemas/SnapshotVersion' x-go-name: Versions viewBoxId: description: 'Specifies the id of the Domain (View Box) where this object is stored.' type: - integer - 'null' format: int64 x-go-name: ViewBoxId viewName: description: Specifies the View name where this object is stored. type: - string - 'null' x-go-name: ViewName x-go-package: cohesity/iris/server/data/public SnapshotVersion: description: Specifies information about snapshots of a backup object. type: object title: Snapshot Version. properties: attemptNumber: description: 'Specifies the number of the attempts made by the Job Run to capture a snapshot of the object. For example, if an snapshot is successfully captured after three attempts, this field equals 3.' type: - integer - 'null' format: int64 x-go-name: AttemptNumber deltaSizeBytes: description: 'Specifies the size of the data captured from the source object. For a full backup (where Change Block Tracking is not utilized) this field is equal to logicalSizeBytes. For an incremental backup (where Change Block Tracking is utilized), this field specifies the size of the data that has changed since the last backup.' type: - integer - 'null' format: int64 x-go-name: DeltaSizeBytes indexingStatus: description: 'Specifies the indexing status of the snapshot. Specifies the indexing status of the snapshot. ''kStarted'' indicates that indexing has started. ''kDone'' indicates that indexing has been completed according to the type of object. ''kNoIndex'' indicates that the snapshot cannot be indexed. This is the case during archival restore. ''kIceboxRestoreStarted'' indicates that indexing is started from an archive. ''kIceboxRestoreError'' indicates that an error occurred during restore from archiveand there is no index present. ''kSkipped'' indicates that indexing is skipped due to indexing backlog.' type: - string - 'null' enum: - kStarted - kDone - kNoIndex - kIceboxRestoreStarted - kIceboxRestoreError - kSkipped x-go-name: IndexingStatus isAppConsistent: description: 'Specifies if an app-consistent snapshot was captured. For example, was the VM was quiesced before the snapshot was captured.' type: - boolean - 'null' x-go-name: IsAppConsistent isFullBackup: description: 'Specifies if the snapshot is a full backup. For example, all blocks of the VM is captured and Change Block Tracking is not utilized.' type: - boolean - 'null' x-go-name: IsFullBackup jobRunId: description: Specifies the id of the Job Run that captured the snapshot. type: - integer - 'null' format: int64 x-go-name: JobRunId localMountPath: description: 'Specifies the local path relative to the View, without the ViewBox/View prefix.' type: - string - 'null' x-go-name: LocalMountPath logicalSizeBytes: description: 'Specifies the size of the snapshot if the data is fully hydrated or expanded and not reduced by change-block tracking, compression and deduplication. For example if a VMDK of size 100GB is created with thin provisioning and the disk size to store the VMDK is 20GB. The logical size of this object is 100GB and the physical size is 20GB.' type: - integer - 'null' format: int64 x-go-name: LogicalSizeBytes physicalSizeBytes: description: 'Specifies the amount of data actually used on the disk to store this object after being reduced by change-block tracking, compression and deduplication.' type: - integer - 'null' format: int64 x-go-name: PhysicalSizeBytes primaryPhysicalSizeBytes: description: 'Specifies the total amount of disk space used to store this object on the primary storage. For example the total amount of disk space used to store the VM files (such as the VMDK files) on the primary datastore.' type: - integer - 'null' format: int64 x-go-name: PrimaryPhysicalSizeBytes replicaInfoList: description: Specifies the list of replication information about the current snapshot. type: - array - 'null' items: $ref: '#/components/schemas/ReplicaInfo' x-go-name: ReplicaInfoList 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 RestorePointsForTimeRangeParam: description: Specifies the request parameters to restore points for time range API. type: object title: Restore Points for Time Range Parameters. required: - jobUids properties: endTimeUsecs: description: 'Specifies the end time specified as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: EndTimeUsecs environment: description: 'Specifies the protection source environment type. 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 jobUids: description: Specifies the jobs for which to get the full snapshot information. type: - array - 'null' items: $ref: '#/components/schemas/UniversalId' x-go-name: JobUids protectionSourceId: description: Specifies the id of the Protection Source which is to be restored. type: - integer - 'null' format: int64 x-go-name: ProtectionSourceId startTimeUsecs: description: 'Specifies the start time specified as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: StartTimeUsecs x-go-package: cohesity/iris/server/data/public SnapshotTargetSettings: description: 'Specifies settings about a target where a copied Snapshot is stored. A target can be a Remote Cluster or an Archival External Target such as AWS or Tape.' type: object title: Snapshot Target. properties: archivalTarget: description: 'Specifies the Archival External Target for storing a copied Snapshot. If the type is not ''kLocal'', either a replicationTarget, archivalExternalTarget or cloudReplicationTarget must be specified.' $ref: '#/components/schemas/ArchivalExternalTarget' cloudReplicationTarget: description: 'Specifies the cloud replication target for storing a copied Snapshot. If the type is not ''kLocal'', either a replicationTarget, archivalExternalTarget or cloudReplicationTarget must be specified.' $ref: '#/components/schemas/CloudDeployTargetDetails' replicationTarget: description: 'Specifies the replication target (Remote Cluster) for storing a copied Snapshot. If the type is not ''kLocal'', either a replicationTarget, archivalExternalTarget or cloudReplicationTarget must be specified.' $ref: '#/components/schemas/ReplicationTargetSettings' type: description: 'Specifies the type of a Snapshot target such as ''kLocal'', ''kRemote'' or ''kArchival''. ''kLocal'' means the Snapshot is stored on a local Cohesity Cluster. ''kRemote'' means the Snapshot is stored on a Remote Cohesity Cluster. (It was copied to the Remote Cohesity Cluster using replication.) ''kArchival'' means the Snapshot is stored on a Archival External Target (such as Tape or AWS). ''kCloudDeploy'' means the Snapshot is stored on a Cloud platform.' type: - string - 'null' enum: - kLocal - kRemote - kArchival - kCloudDeploy - kCloudReplication x-go-name: Type x-go-package: cohesity/iris/server/data/public 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 RestoreTask: description: Specifies information about a Restore Task. type: object title: Restore Task. required: - name properties: acropolisParameters: description: Specifies parameters for 'kAcropolis' restore task. $ref: '#/components/schemas/AcropolisRestoreParameters' applicationParameters: description: Specifies parameters for restore task of application server object. $ref: '#/components/schemas/ApplicationRestoreParameters' archiveTaskUid: description: 'Specifies the uid of the Restore Task that retrieves objects from an archive. This field is only populated when objects must be retrieved from an archive before being restored. This field is deprecated. deprecated:true' allOf: - $ref: '#/components/schemas/UniversalId' archiveTaskUids: description: 'Specifies the uids of the Restore Task that retrieves objects from an archive. This field is only populated when objects must be retrieved from an archive before being restored. overrideDescription:true' type: - array - 'null' items: $ref: '#/components/schemas/UniversalId' x-go-name: ArchiveTaskUids canTearDown: description: 'Specifies whether it is possible to tear down the objects created by the recovery.' type: - boolean - 'null' x-go-name: CanTearDown cloneViewParameters: description: Specifies the View settings used when cloning a View. allOf: - $ref: '#/components/schemas/UpdateViewParam' 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 datastoreId: description: 'Specifies the datastore where the object''s files are recovered to. This field is populated when objects are recovered to a different resource pool or to a different parent source. This field is not populated when objects are recovered to their original datastore locations in the original parent source.' type: - integer - 'null' format: int64 x-go-name: DatastoreId deployVmsToCloud: description: Specifies parameters to deploy VMs to cloud. $ref: '#/components/schemas/DeployVmsToCloud' endTimeUsecs: description: 'Specifies the end time of the Restore Task as a Unix epoch Timestamp (in microseconds). This field is only populated if the Restore Task completes.' type: - integer - 'null' format: int64 x-go-name: EndTimeUsecs error: description: 'Specifies the error reported by the Restore Task (if any) after the Task has finished.' title: Restore Task Error. allOf: - $ref: '#/components/schemas/RequestError' fullViewName: description: Specifies the full name of a View. type: - string - 'null' x-go-name: FullViewName hypervParameters: description: Specifies additional parameters for 'kHyperV' restore objects. $ref: '#/components/schemas/HypervRestoreParameters' id: description: 'Specifies the id of the Restore Task assigned by Cohesity Cluster.' type: - integer - 'null' format: int64 x-go-name: Id mountVolumesState: description: 'Specifies the states of mounting all the volumes onto a mount target for a ''kRecoverVMs'' Restore Task.' $ref: '#/components/schemas/MountVolumesState' 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 oneDriveParameters: description: Specifies additional parameters for 'kRecoverO365Drive' restore task. $ref: '#/components/schemas/OneDriveRestoreParameters' outlookParameters: description: Specifies parameters for 'kRecoverEmails' restore task. $ref: '#/components/schemas/OutlookRestoreParameters' publicFoldersParameters: description: 'Specifies additional parameters for ''kRecoverO365PublicFolders'' restore task.' $ref: '#/components/schemas/PublicFoldersRestoreParameters' restoreObjectState: description: 'Array of Object States. Specifies the states of all the objects for the ''kRecoverVMs'' and ''kCloneVMs'' Restore Tasks.' type: - array - 'null' items: $ref: '#/components/schemas/RestoreObjectState' x-go-name: RestoreObjectState sharePointParameters: description: Specifies additional parameters for 'kRecoverSites' restore task. $ref: '#/components/schemas/SharePointRestoreParameters' startTimeUsecs: description: 'Specifies the start time for the Restore Task as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: StartTimeUsecs status: description: 'Specifies the overall status of the Restore Task. ''kReadyToSchedule'' indicates the Restore Task is waiting to be scheduled. ''kProgressMonitorCreated'' indicates the progress monitor for the Restore Task has been created. ''kRetrievedFromArchive'' indicates that the objects to restore have been retrieved from the specified archive. A Task will only ever transition to this state if a retrieval is necessary. ''kAdmitted'' indicates the task has been admitted. After a task has been admitted, its status does not move back to ''kReadyToSchedule'' state even if it is rescheduled. ''kInProgress'' indicates that the Restore Task is in progress. ''kFinishingProgressMonitor'' indicates that the Restore Task is finishing its progress monitoring. ''kFinished'' indicates that the Restore Task has finished. The status indicating success or failure is found in the error code that is stored with the Restore Task. ''kInternalViewCreated'' indicates that internal view for the task has been created. ''kZipFileRequested'' indicates that request has been sent to create zip files for the files to be downloaded. This state is only going to be present for kDownloadFiles Task. ''kCancelled'' indicates that task or jb has been cancelled.' type: - string - 'null' enum: - kReadyToSchedule - kProgressMonitorCreated - kRetrievedFromArchive - kAdmitted - kInProgress - kFinishingProgressMonitor - kFinished - kInternalViewCreated - kZipFileRequested - kCancelled x-go-name: Status targetViewCreated: description: 'Is true if a new View was created by a ''kCloneVMs'' Restore Task. This field is only set for a ''kCloneVMs'' Restore Task.' type: - boolean - 'null' x-go-name: TargetViewCreated tearDownErrorMessage: description: Specifies the error message about the tear down operation if it fails. type: - string - 'null' x-go-name: TearDownErrorMessage tearDownStatus: description: 'Specifies the status of the tear down operation. This is only set when the field ''CanTearDown'' is set to true. ''kReadyToSchedule'' indicates that the task is waiting to be scheduled. ''kAdmitted'' indicates that the task has been admitted. ''kFinished'' indicates that the task is finished with or without error.' type: - string - 'null' enum: - kReadyToSchedule - kAdmitted - kFinished x-go-name: TearDownStatus type: description: 'Specifies the type of Restore Task. ''kRecoverVMs'' specifies a Restore Task that recovers VMs. ''kCloneVMs'' specifies a Restore Task that clones VMs. ''kCloneView'' specifies a Restore Task that clones a View. ''kMountVolumes'' specifies a Restore Task that mounts volumes. ''kRestoreFiles'' specifies a Restore Task that recovers files and folders. ''kRecoverApp'' specifies a Restore Task that recovers app. ''kCloneApp'' specifies a Restore Task that clone app. ''kRecoverSanVolume'' specifies a Restore Task that recovers SAN volumes. ''kConvertAndDeployVMs'' specifies a Restore Task that converts and deploy VMs to a target environment. ''kMountFileVolume'' specifies a Restore Task that mounts a file volume. ''kSystem'' specifies a Restore Task that recovers a system. ''kRecoverVolumes'' specifies a Restore Task that recovers volumes via the physical agent. ''kDeployVolumes'' specifies a Restore Task that deploys volumes to a target environment. ''kDownloadFiles'' specifies a Restore Task that downloads the requested files and folders in zip format. ''kRecoverEmails'' specifies a Restore Task that recovers the mailbox/email items. ''kRecoverDisks'' specifies a Restore Task that recovers the virtual disks. ''kRecoverNamespaces'' specifies a Restore Task that recovers Kubernetes namespaces. ''kCloneVMsToView'' specifies a Restore Task that clones VMs into a View.' type: - string - 'null' enum: - kRecoverVMs - kCloneVMs - kCloneView - kMountVolumes - kRestoreFiles - kRecoverApp - kCloneApp - kRecoverSanVolume - kConvertAndDeployVMs - kMountFileVolume - kSystem - kRecoverVolumes - kDeployVMs - kDownloadFiles - kRecoverEmails - kRecoverDisks - kRecoverNamespaces - kCloneVMsToView x-go-name: Type username: description: Specifies the Cohesity user who requested this Restore Task. type: - string - 'null' x-go-name: Username viewBoxId: description: Specifies the id of the Domain (View Box) where the View is stored. type: - integer - 'null' format: int64 x-go-name: ViewBoxId virtualDiskRestoreState: description: Specifies the state of recovering all the specifies virtual disks of a vm. $ref: '#/components/schemas/VirtualDiskRecoverTaskState' vlanParameters: description: Specifies VLAN parameters for the restore operation. $ref: '#/components/schemas/VlanParameters' vmwareParameters: description: Specifies additional parameters for 'kVmware' restore objects. $ref: '#/components/schemas/VmwareRestoreParameters' x-go-package: cohesity/iris/server/data/public ElastifileProtectionSource: description: Specifies a Protection Source in Elastifile environment. type: object title: Elastifile Protection Source. properties: cluster: description: 'Specifies information of Elastifile Cluster. This is set only when the entity type is ''kCluster''.' $ref: '#/components/schemas/ElastifileCluster' container: description: 'Specifies a container in an Elastifile Cluster. This is set only when the entity type is ''kContainer''.' $ref: '#/components/schemas/ElastifileContainer' name: description: Specifies a unique name of the Protection Source. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of the entity in an Elastifile file system like ''kCluster'', ''kContainer''. ''kCluster'' indicates an Elastifile Cluster. ''kContainer'' indicates a container on Elastifile cluster.' type: - string - 'null' enum: - kCluster - kContainer x-go-name: Type x-go-package: cohesity/iris/server/data/public OracleContainerDatabaseInfo: description: 'Specifies the Container Database information along with the Pluggable DBs within the container. The multitenant architecture enables an Oracle database to function as a multitenant container database (CDB). A CDB includes zero, one, or many customer-created pluggable databases (PDBs).' type: object properties: pluggableDatabaseInfoList: description: Specifies the list of Pluggable databases within this Container Database. type: - array - 'null' items: $ref: '#/components/schemas/OraclePluggableDatabaseInfo' x-go-name: PluggableDatabaseInfoList x-go-package: cohesity/iris/server/data/public ExchangeDAGProtectionPreference: description: 'Specifies the information about the preference order while choosing between which database copy of the database which is part of DAG should be protected.' type: object title: Exchange DAG Backup preference properties: passiveCopyPreferenceServerGuidList: description: 'Specifies the preference order of the exchange servers from which passive database copies should be protected. The preference order is descending which indicates that passive database copy in the first server in the list gets the highest preference.' type: - array - 'null' items: type: string x-go-name: PassiveCopyPreferenceServerGuidList passiveOnly: description: 'Specifies that only passive database copies should be protected if this is set to true. If this is set to false, both active and passive database copies can be protected.' type: - boolean - 'null' x-go-name: PassiveOnly useUserSpecifiedPassivePreferenceOrder: description: 'Specifies to use the user specified preference order of exchange servers from which the passive database copies should be protected if this is set to true. Every copy of an Exchange database in a DAG is assigned an activation preference number. This number is used by the system as part of the passive database activation process. If this bool flag is set to false, the reverse order of activation is used while choosing between passive copies.' type: - boolean - 'null' x-go-name: UseUserSpecifiedPassivePreferenceOrder x-go-package: cohesity/iris/server/data/public KubernetesRestoreParameters: description: Specifies the information required for recovering kubernetes entities. type: object title: Kubernetes Restore Parameters. properties: prefix: description: 'Specifies a prefix to prepended to the source object name to derive a new name for the recovered or cloned object. By default, cloned or recovered objects retain their original name. Length of this field is limited to 8 characters.' type: - string - 'null' x-go-name: Prefix suffix: description: 'Specifies a suffix to appended to the original source object name to derive a new name for the recovered or cloned object. By default, cloned or recovered objects retain their original name. Length of this field is limited to 8 characters.' type: - string - 'null' x-go-name: Suffix x-go-package: cohesity/iris/server/data/public NetappVolumeInfo: description: Specifies information about a volume in a NetApp cluster. type: object title: NetApp Volume Information. properties: aggregateName: description: Specifies the containing aggregate name of this volume. type: - string - 'null' x-go-name: AggregateName capacityBytes: description: Specifies the total capacity in bytes of this volume. type: - integer - 'null' format: int64 x-go-name: CapacityBytes cifsShares: description: 'Array of CIFS Shares. Specifies the set of CIFS Shares exported for this volume.' type: - array - 'null' items: $ref: '#/components/schemas/CifsShareInfo' x-go-name: CifsShares creationTimeUsecs: description: 'Specifies the creation time of the volume specified in Unix epoch time (in microseconds).' type: - integer - 'null' format: int64 x-go-name: CreationTimeUsecs dataProtocols: description: 'Array of Data Protocols. Specifies the set of data protocols supported by this volume. ''kNfs'' indicates NFS connections. ''kCifs'' indicates SMB (CIFS) connections. ''kIscsi'' indicates iSCSI connections. ''kFc'' indicates Fiber Channel connections. ''kFcache'' indicates Flex Cache connections. ''kHttp'' indicates HTTP connections. ''kNdmp'' indicates NDMP connections. ''kManagement'' indicates non-data connections used for management purposes. ''kNvme'' indicates NVMe connections.' type: - array - 'null' items: type: string enum: - kNfs - kCifs - kIscsi - kFc - kFcache - kHttp - kNdmp - kManagement - kNvme x-go-name: DataProtocols exportPolicyName: description: 'Specifies the name of the export policy (which defines the access permissions for the mount client) that has been assigned to this volume.' type: - string - 'null' x-go-name: ExportPolicyName junctionPath: description: 'Specifies the junction path of this volume. This path can be used to mount this volume via protocols such as NFS.' type: - string - 'null' x-go-name: JunctionPath name: description: Specifies the name of the NetApp Vserver that this volume belongs to. type: - string - 'null' x-go-name: Name securityInfo: description: Specifies the security information of this volume. $ref: '#/components/schemas/VolumeSecurityInfo' state: description: 'Specifies the state of this volume. Specifies the state of a NetApp Volume. ''kOnline'' indicates the volume is online. Read and write access to this volume is allowed. ''kRestricted'' indicates the volume is restricted. Some operations, such as parity reconstruction, are allowed, but data access is not allowed. ''kOffline'' indicates the volume is offline. No access to the volume is allowed. ''kMixed'' indicates the volume is in mixed state, which means its aggregates are not all in the same state.' type: - string - 'null' enum: - kOnline - kRestricted - kOffline - kMixed x-go-name: State type: description: 'Specifies the NetApp type of this volume. Specifies the type of a NetApp Volume. ''kReadWrite'' indicates read-write volume. ''kLoadSharing'' indicates load-sharing volume. ''kDataProtection'' indicates data-protection volume. ''kDataCache'' indicates data-cache volume. ''kTmp'' indicates temporary purpose. ''kUnknownType'' indicates unknown type.' type: - string - 'null' enum: - kReadWrite - kLoadSharing - kDataProtection - kDataCache - kTmp - kUnknownType x-go-name: Type usedBytes: description: Specifies the total space (in bytes) used in this volume. type: - integer - 'null' format: int64 x-go-name: UsedBytes x-go-package: cohesity/iris/server/data/public responses: GetFileFstatInformationResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/FileFstatResult' GetVmVolumesInformationResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/VmVolumesInformation' GetAdDomainRootTopologyResponse: description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/AdRootTopologyObject' GetVmDirectoryListResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/VmDirectoryListResult' AdObjectsRestoreStatusResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/AdObjectsRestoreStatus' SuccessResponse: description: Success Response ListStorageProfilesResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/ListStorageProfilesResponseBody' SearchObjectsResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/ObjectSearchResults' CreateDownloadFilesAndFoldersResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/RestoreTask' CreateRestoreFilesTaskResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/RestoreTask' CreateDeployTaskResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/RestoreTask' NoContentResponse: description: No Content GetRestorePointsForTimeRangeResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/RestorePointsForTimeRange' CreateRecoverTaskResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/RestoreTask' CompareAdObjectsResponse: description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/ComparedADObject' GetRestoreTasksResponse: description: Success content: application/json: schema: type: array title: Array of Restore Tasks. items: $ref: '#/components/schemas/RestoreTask' SearchRestoredFilesResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/FileSearchResults' GetFileSnapshotsInformationResponse: description: Success content: application/json: schema: description: 'Specifies an array of snapshots that contain the folder or file. In addition, information about each file or folder is provided.' type: array title: Array of Snapshots and File/Folder Information. items: $ref: '#/components/schemas/FileSnapshotInformation' GetVirtualDiskInformationResponse: description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualDiskInformation' SearchAdObjectsResponse: description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/ADObject' Error: description: Error content: application/json: schema: $ref: '#/components/schemas/RequestError' UpdateRestoreTaskResponse: description: 'Specifies the response of the UpdateRestoreTask API. Success' content: application/json: schema: $ref: '#/components/schemas/RestoreTask' GetRestoreTaskByIdResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/RestoreTask' CreateCloneTaskResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/RestoreTask'