openapi: 3.2.0 info: title: Cohesity Reports API version: '1.0' description: 'Operations tagged Reports across 2 of this provider''s published API definitions: cohesity-cluster-v1-openapi-original.yml, cohesity-helios-reporting-openapi-original.yml. Each path carries the servers of the definition it was published in.' servers: - url: https:///irisservices/api/v1 - url: https://helios.cohesity.com/heliosreporting/api/v1 tags: - name: Reports paths: /public/reports/agents: get: description: 'Get the list of all the installed agents which includes the health status and upgradability of the agent.' tags: - Reports operationId: GetAgentDeploymentReport parameters: - x-go-name: HostOsType description: 'Specifies the host type on which the Cohesity agent is installed. Setting this parameter will filter the response based on host OS type on which agent is running. ''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.' name: hostOsType in: query schema: type: array items: enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther type: string - x-go-name: CompactVersion description: 'Specifies the compact version of Cohesity agent. For example, 6.0.1. Setting this parameter will filter the response based on installed agent version.' name: compactVersion in: query schema: type: string - x-go-name: OutputFormat description: 'Specifies the format for the output such as ''csv'' or ''json''. If not specified, the json format is returned. If ''csv'' is specified, a comma-separated list with a heading row is returned.' name: outputFormat in: query schema: type: string - x-go-name: HealthStatus description: 'Specifies the health status of the Cohesity agent. Setting this parameter will filter the response based on agent health 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.' name: healthStatus in: query schema: type: array items: enum: - kUnknown - kUnreachable - kHealthy - kDegraded type: string responses: '200': $ref: '#/components/responses/GetAgentDeploymentReportResponse' default: $ref: '#/components/responses/Error' summary: Get agent deployment report x-summary-source: derived servers: - url: https:///irisservices/api/v1 /public/reports/dataTransferFromVaults: get: description: 'A Vault can provide an additional Cloud Tier where cold data of the Cohesity Cluster is stored in the Cloud. A Vault can also provide archive storage for backup data. This archive data is stored on Tapes and in Cloud Vaults.' tags: - Reports summary: Get summary statistics about transferring data from Vaults (External Targets)… operationId: GetDataTransferFromVaultsReportRequest parameters: - x-go-name: StartTimeMsecs description: 'Filter by a start time. Specify the start time as a Unix epoch Timestamp (in milliseconds). If startTimeMsecs and endTimeMsecs are not specified, the time period is the last 7 days.' name: startTimeMsecs in: query schema: type: integer format: int64 - x-go-name: EndTimeMsecs description: 'Filter by end time. Specify the end time as a Unix epoch Timestamp (in milliseconds). If startTimeMsecs and endTimeMsecs are not specified, the time period is the last 7 days.' name: endTimeMsecs in: query schema: type: integer format: int64 - x-go-name: VaultIds description: Filter by a list of Vault ids. name: vaultIds in: query required: true schema: type: array items: type: integer format: int64 - x-go-name: OutputFormat description: 'Specifies the format for the output such as ''csv'' or ''json''. If not specified, the json format is returned. If ''csv'' is specified, a comma-separated list with a heading row is returned.' name: outputFormat in: query schema: type: string - x-go-name: GroupBy description: 'Specifies wheather the report should be grouped by target when scheduled or downloaded. If not set or set to false, report is grouped by protection jobs. It is ignored if outformat is not "csv" and response contains whole report.' name: groupBy in: query schema: type: integer format: int32 responses: '200': $ref: '#/components/responses/GetDataTransferFromVaultsSummaryResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/reports/dataTransferToVaults: get: description: 'A Vault can provide an additional Cloud Tier where cold data of the Cohesity Cluster can be stored in the Cloud. A Vault can also provide archive storage for backup data. This archive data is stored on Tapes and in Cloud Vaults.' tags: - Reports summary: Get summary statistics about transferring data from the Cohesity Cluster to… operationId: GetDataTransferToVaultsReportRequest parameters: - x-go-name: StartTimeMsecs description: 'Filter by a start time. Specify the start time as a Unix epoch Timestamp (in milliseconds). If startTimeMsecs and endTimeMsecs are not specified, the time period is the last 7 days.' name: startTimeMsecs in: query schema: type: integer format: int64 - x-go-name: EndTimeMsecs description: 'Filter by end time. Specify the end time as a Unix epoch Timestamp (in milliseconds). If startTimeMsecs and endTimeMsecs are not specified, the time period is the last 7 days.' name: endTimeMsecs in: query schema: type: integer format: int64 - x-go-name: VaultIds description: Filter by a list of Vault ids. name: vaultIds in: query required: true schema: type: array items: type: integer format: int64 - x-go-name: OutputFormat description: 'Specifies the format for the output such as ''csv'' or ''json''. If not specified, the json format is returned. If ''csv'' is specified, a comma-separated list with a heading row is returned.' name: outputFormat in: query schema: type: string - x-go-name: GroupBy description: 'Specifies wheather the report should be grouped by target when scheduled or downloaded. If not set or set to false, report is grouped by protection jobs. It is ignored if outformat is not "csv" and response contains whole report.' name: groupBy in: query schema: type: integer format: int32 responses: '200': $ref: '#/components/responses/GetDataTransferToVaultsSummaryResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/reports/gdpr: get: description: Returns the GDPR report information. tags: - Reports summary: Get gdpr report related information operationId: GetGdprReport parameters: - x-go-name: ObjectIds description: Specifies the objects for which to get the gdpr information. name: id in: query schema: type: array items: type: integer format: int64 - x-go-name: AccessibleUsers description: Specifies the users for which to get the accessible objects. name: accessibleUsers in: query schema: type: array items: type: string - x-go-name: ParentSourceId description: Specifies the parent sources of objects for which to get info for. name: parentSourceId in: query schema: type: array items: type: integer format: int64 - x-go-name: OutputFormat description: 'Specifies the format for the output such as ''csv'' or ''json''. If not specified, the json format is returned. If ''csv'' is specified, a comma-separated list with a heading row is returned.' name: outputFormat in: query schema: type: string - x-go-name: Actions description: Specifies the action for the audit logs. name: actions in: query schema: type: array items: type: string - x-go-name: Search description: Specifies the search string for the audit logs. name: search in: query schema: type: string - x-go-name: StartTimeUsecs description: 'Specifies the start time for the audit logs as a Unix epoch Timestamp (in microseconds).' name: startTimeUsecs in: query schema: type: integer format: int64 - x-go-name: EndTimeUsecs description: 'Specifies the end time for the audit logsas a Unix epoch Timestamp (in microseconds).' name: endTimeUsecs in: query schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/GetGdprReportResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/reports/protectedObjectsTrends: get: description: 'This gives a summary of protection trend for protected resources during the given time range. If no roll up is specified, then the trends will be grouped by days.' tags: - Reports summary: Get protected objects trends grouped by days/weeks/months operationId: GetProtectedObjectsTrendsReportRequest parameters: - x-go-name: JobIds description: 'Filter by a list of Job ids. Snapshots summary statistics for the specified Protection Jobs are reported.' name: jobIds in: query schema: type: array items: type: integer format: int64 - x-go-name: StartTimeUsecs description: 'Filter by a start time. Snapshot summary statistics for Job Runs that started after the specified time are reported. Specify the start time as a Unix epoch Timestamp (in microseconds).' name: startTimeUsecs in: query schema: type: integer format: int64 - x-go-name: Timezone description: 'Specifies the timezone to use when calculating day/week/month Specify the timezone in the following format: "Area/Location", for example: "America/New_York".' name: timezone in: query required: true schema: type: string - x-go-name: EndTimeUsecs description: 'Filter by end time. Snapshot summary statistics for Job Runs that ended before the specified time are returned. Specify the end time as a Unix epoch Timestamp (in microseconds).' name: endTimeUsecs in: query schema: type: integer format: int64 - x-go-name: Environments description: 'Filter by a list of environment types such as ''kVMware'', ''kView'', etc. 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: environments in: query schema: type: array items: 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 type: string - x-go-name: ProtectedObjectIds description: 'Filter by a list of leaf Protection Sources Objects (such as VMs). Snapshot summary statistics for the listed Protection Source Objects are reported.' name: protectedObjectIds in: query schema: type: array items: type: integer format: int64 - x-go-name: RegisteredEntityId description: 'Specifies an id of a top level Registered Source such as a vCenter Server. If specified, Snapshot summary statistics for all the leaf Protection Sources (such as VMs) that are children of this Registered Source are reported. NOTE: If specified, filtering by other fields is not supported.' name: registeredSourceId in: query schema: type: integer format: int64 - x-go-name: RollUp description: Roll up type for grouping. Valid values are day, week, month name: rollup in: query schema: type: string - x-go-name: TenantIds description: 'TenantIds contains ids of the tenants for which objects are to be returned.' name: tenantIds in: query schema: type: array items: type: string - x-go-name: AllUnderHierarchy description: 'AllUnderHierarchy specifies if objects of all the tenants under the hierarchy of the logged in user''s organization should be returned.' name: allUnderHierarchy in: query schema: type: boolean responses: '200': $ref: '#/components/responses/ProtectedObjectsTrendsReportResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/reports/protectionSourcesJobRuns: get: description: 'Returns the Snapshots that contain backups of the specified Protection Source Objects and match the specified filter criteria.' tags: - Reports summary: Get protection details about the specified list of leaf Protection Source… operationId: GetProtectionSourcesJobRunsReportRequest parameters: - x-go-name: TenantIds description: 'TenantIds contains ids of the tenants for which objects are to be returned.' name: tenantIds in: query schema: type: array items: type: string - x-go-name: AllUnderHierarchy description: 'AllUnderHierarchy specifies if objects of all the tenants under the hierarchy of the logged in user''s organization should be returned.' name: allUnderHierarchy in: query schema: type: boolean - x-go-name: JobIds description: 'Filter by a list of Job ids. Snapshots for the specified Protection Jobs are listed.' name: jobIds in: query schema: type: array items: type: integer format: int64 - x-go-name: StartTimeUsecs description: 'Filter by a start time. Snapshots that started after the specified time are returned. Specify the start time as a Unix epoch Timestamp (in microseconds).' name: startTimeUsecs in: query schema: type: integer format: int64 - x-go-name: EndTimeUsecs description: 'Filter by a end time. Snapshots that ended before the specified time are returned. Specify the end time as a Unix epoch Timestamp (in microseconds).' name: endTimeUsecs in: query schema: type: integer format: int64 - x-go-name: Environments description: 'Filter by a list of environment types such as ''kVMware'', ''kView'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter.' name: environments in: query schema: type: array items: 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 - kVCD - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kKubernetes - kElastifile type: string - x-go-name: ProtectionSourceIds description: 'Filter by a list of leaf Protection Sources Objects (such as VMs). Snapshots of the specified Protection Source Objects are returned.' name: protectionSourceIds in: query required: true schema: type: array items: type: integer format: int64 - x-go-name: OutputFormat description: 'Specifies the format for the output such as ''cvs'' or ''json''. If not specified, the json format is returned. If ''csv'' is specified, a comma-separated list with a heading row is returned.' name: outputFormat in: query schema: type: string - x-go-name: PageCount description: 'Specifies the number of Snapshots to return in the response for pagination purposes. Used in combination with the paginationCookie in the response to return multiple sets of Snapshots.' name: pageCount in: query schema: type: integer format: int32 - x-go-name: RunStatus description: 'Filter by a list of run statuses such as ''kRunning'', ''kSuccess'', ''kFailure'' etc. Snapshots of Job Runs with the specified run statuses are reported. ''kSuccess'' indicates that the Job Run was successful. ''kRunning'' indicates that the Job Run is currently running. ''kWarning'' indicates that the Job Run was successful but warnings were issued. ''kCancelled'' indicates that the Job Run was canceled. ''kError'' indicates the Job Run encountered an error and did not run to completion.' name: runStatus in: query schema: type: array items: enum: - kSuccess - kRunning - kWarning - kCancelled - kError type: string responses: '200': $ref: '#/components/responses/ProtectionSourcesJobRunsReportResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/reports/protectionSourcesJobsSummary: get: description: 'For example, if two Job ids are passed in, Snapshot summary statistics about all the leaf Objects that have been protected by the two specified Jobs are reported. For example, if a top level registered Source id is passed in, summary statistics about all the Snapshots backing up leaf Objects in the specified Source are reported.' tags: - Reports summary: Get Job Run (Snapshot) summary statistics about the leaf Protection Sources… operationId: GetProtectionSourcesJobsSummaryReportRequest parameters: - x-go-name: JobIds description: 'Filter by a list of Job ids. Snapshots summary statistics for the specified Protection Jobs are reported.' name: jobIds in: query schema: type: array items: type: integer format: int64 - x-go-name: StartTimeUsecs description: 'Filter by a start time. Snapshot summary statistics for Job Runs that started after the specified time are reported. Specify the start time as a Unix epoch Timestamp (in microseconds).' name: startTimeUsecs in: query schema: type: integer format: int64 - x-go-name: EndTimeUsecs description: 'Filter by end time. Snapshot summary statistics for Job Runs that ended before the specified time are returned. Specify the end time as a Unix epoch Timestamp (in microseconds).' name: endTimeUsecs in: query schema: type: integer format: int64 - x-go-name: Environments description: 'Filter by a list of environment types such as ''kVMware'', ''kView'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter.' name: environments in: query schema: type: array items: 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 - kVCD - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kKubernetes - kElastifile type: string - x-go-name: ProtectionSourceIds description: 'Filter by a list of leaf Protection Sources Objects (such as VMs). Snapshot summary statistics for the listed Protection Source Objects are reported.' name: protectionSourceIds in: query schema: type: array items: type: integer format: int64 - x-go-name: Statuses description: 'Filter by a list of run statuses. ''kSuccess'' indicates that the Job Run was successful. ''kRunning'' indicates that the Job Run is currently running. ''kWarning'' indicates that the Job Run was successful but warnings were issued. ''kCancelled'' indicates that the Job Run was canceled. ''kError'' indicates the Job Run encountered an error and did not run to completion.' name: statuses in: query schema: type: array items: enum: - kSuccess - kRunning - kWarning - kCancelled - kError type: string - x-go-name: OutputFormat description: 'Specifies the format for the output such as ''csv'' or ''json''. If not specified, the json format is returned. If ''csv'' is specified, a comma-separated list with a heading row is returned.' name: outputFormat in: query schema: type: string - x-go-name: RegisteredEntityId description: 'Specifies an id of a top level Registered Source such as a vCenter Server. If specified, Snapshot summary statistics for all the leaf Protection Sources (such as VMs) that are children of this Registered Source are reported. NOTE: If specified, filtering by other fields is not supported.' name: registeredSourceId in: query schema: type: integer format: int64 - x-go-name: ConsecutiveFailures description: 'Filters out those jobs which have number of consecutive run failures less than consecutiveFailures.' name: consecutiveFailures in: query schema: type: integer format: int32 - x-go-name: ReportName description: Specifies the custom report name the user wants to set for this report. name: reportName in: query schema: type: string - x-go-name: ReportType description: 'Specifies the report type that will be used to set the right label & subject line for the report when downloaded or emailed because same API is used for 3 reports currently 1. kAvailableLocalSnapshotsReport 2. kFailedObjectsReport 3. kProtectionSummaryByObjectTypeReport' name: reportType in: query schema: type: integer format: int32 - x-go-name: TenantIds description: 'TenantIds contains ids of the tenants for which objects are to be returned.' name: tenantIds in: query schema: type: array items: type: string - x-go-name: AllUnderHierarchy description: 'AllUnderHierarchy specifies if objects of all the tenants under the hierarchy of the logged in user''s organization should be returned.' name: allUnderHierarchy in: query schema: type: boolean responses: '200': $ref: '#/components/responses/ProtectionSourcesJobsSummaryReportResponseBodyWrapper' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/reports/report-types/{reportType}: get: description: Fetches list of properties of a report type. tags: - Reports summary: List properties of a report type operationId: GetReportType parameters: - name: reportType in: path required: true description: Specifies the report type. schema: type: string enum: - ClusterConnections - ClusterConnectionsTrend - ProtectedUnprotectedObjects - ProtectedObjects - ProtectionActivity - ProtectionGroupSummary - ProtectionRuns - ProtectionRunsTrend - StorageConsumptionByObjects - StorageConsumptionByProtectionGroups - StorageConsumptionByClusters - StorageConsumptionByStorageDomains - StorageConsumptionByOrganizations - StorageConsumptionByClustersTrend - StorageConsumptionByViews - ServiceConsumption - ServiceConsumptionTrend - Recovery - Failures - ProtectionSummaryBySystem - DataTransferredToExternalTargets - DataTransferredToExternalTargetsTrend responses: 200: $ref: '#/components/responses/GetReportTypeAttributesResponse' default: $ref: '#/components/responses/ErrorResponse' security: - ApiKeyAuth: [] servers: - url: https://helios.cohesity.com/heliosreporting/api/v1 /public/reports: get: description: Fetches list of all reports accessible by logged in user. tags: - Reports summary: List Reports operationId: GetReports parameters: - name: ids in: query description: Specifies the ids of reports to fetch. schema: type: array items: type: string - name: userContext in: query description: Specifies the user context to filter reports. schema: type: string enum: - DMaaS - Hybrid - MCM - MCMTenant - FortKnox responses: 200: $ref: '#/components/responses/GetReportsResponse' default: $ref: '#/components/responses/ErrorResponse' security: - ApiKeyAuth: [] servers: - url: https://helios.cohesity.com/heliosreporting/api/v1 /public/reports/{id}: get: description: Get a report for a given id. tags: - Reports summary: Fetch a Report operationId: GetReportById parameters: - name: id in: path description: Specifies the id of the report. required: true schema: type: string responses: 200: $ref: '#/components/responses/GetReportByIdResponse' default: $ref: '#/components/responses/ErrorResponse' security: - ApiKeyAuth: [] servers: - url: https://helios.cohesity.com/heliosreporting/api/v1 /public/reports/{id}/preview: post: description: Get preview of a configured report. tags: - Reports summary: Fetch a Report Preview operationId: GetReportPreview parameters: - name: id in: path description: Specifies the id of the report. required: true schema: type: string responses: 200: $ref: '#/components/responses/GetReportPreviewResponse' default: $ref: '#/components/responses/ErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportPreviewParams' description: Request body params in order to preview a given report. required: true security: - ApiKeyAuth: [] servers: - url: https://helios.cohesity.com/heliosreporting/api/v1 /public/reports/{id}/export: post: description: Export a configured report. tags: - Reports summary: Export a Report operationId: ExportReport parameters: - name: id in: path description: Specifies the id of the report. required: true schema: type: string responses: 200: $ref: '#/components/responses/ExportReportResponse' default: $ref: '#/components/responses/ErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportReportParams' description: Request body params in order to export a given report. required: true security: - ApiKeyAuth: [] servers: - url: https://helios.cohesity.com/heliosreporting/api/v1 components: schemas: ClusterAuditLog: description: 'Specifies information about a single Cluster audit log. When an action (such as pausing a Protection Job) occurs, an audit log is generated that provides details about the action.' type: object title: Cluster Audit Log. properties: action: description: Specifies the action that caused the log to be generated. type: - string - 'null' x-go-name: Action clusterInfo: description: Specifies the information of the cluster. type: - string - 'null' x-go-name: ClusterInfo details: description: Specifies more information about the action. type: - string - 'null' x-go-name: Details domain: description: 'Specifies the domain of the user who caused the action that generated the log.' type: - string - 'null' x-go-name: Domain entityId: description: Specifies the id of the entity (object) that the action is invoked on. type: - string - 'null' x-go-name: EntityId entityName: description: 'Specifies the entity (object) name that the action is invoked on. For example, if a Job called BackupEng is paused, this field returns BackupEng.' type: - string - 'null' x-go-name: EntityName entityType: description: 'Specifies the type of the entity (object) that the action is invoked on. For example, if a Job called BackupEng is paused, this field returns ''Protection Job''.' type: - string - 'null' x-go-name: EntityType humanTimestamp: description: 'Specifies the time when the log was generated. The time is specified using a human readable timestamp.' type: - string - 'null' x-go-name: HumanTimestamp impersonation: description: Specifies if the log was generated during impersonation. type: - boolean - 'null' x-go-name: Impersonation ip: description: Specifies the IP address of the user making this action. type: - string - 'null' x-go-name: Ip newRecord: description: Specifies the record after the action is invoked. type: - string - 'null' x-go-name: NewRecord originalTenant: description: 'Specifies the tenant information of the actual user whose action generated the log in case of impersonation.' $ref: '#/components/schemas/Tenant' previousRecord: description: Specifies the record before the action is invoked. type: - string - 'null' x-go-name: PreviousRecord tenant: description: Specifies the tenant information of the user whose action generated the log. $ref: '#/components/schemas/Tenant' timestampUsecs: description: 'Specifies the time when the log was generated. The time is specified using a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: TimestampUsecs userName: description: Specifies the user who caused the action that generated the log. type: - string - 'null' x-go-name: UserName 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 ProtectionJobInfo: description: Specifies basic information about a Protection Job. type: object title: Protection Job Info properties: jobId: description: Specifies the id of the Protection Job. type: - integer - 'null' format: int64 x-go-name: JobId jobName: description: Specifies the name of the Protection Job. type: - string - 'null' x-go-name: JobName type: description: 'Specifies the type of the Protection Job such as kView or kPuppeteer. ''kPuppeteer'' refers to a Remote Adapter Job. 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: Type x-go-package: cohesity/iris/server/data/public S3BucketConfigProto: type: object title: Proto to define the config/metadata of a S3 bucket. properties: acl: description: ACL of the bucket. $ref: '#/components/schemas/ACLProto' lifecycleConfig: description: 'Lifecycle policy of the bucket. If not specified, no lifecycle management is performed for objects in this bucket.' $ref: '#/components/schemas/LifecycleConfigProto' ownerInfo: description: Information about the bucket owner. $ref: '#/components/schemas/OwnerInfo' protocolType: description: Protocol type of this bucket. type: - integer - 'null' format: int32 x-go-name: ProtocolType swiftContainerTag: description: Swfit container tagging information. $ref: '#/components/schemas/SwiftContainerTaggingProto' tagMap: description: 'Tags (or labels) assigned to the bucket. Tags are set of pairs.' type: - array - 'null' items: $ref: '#/components/schemas/S3BucketConfigProto_TagMapEntry' x-go-name: TagMap versioningState: type: - integer - 'null' format: int32 x-go-name: VersioningState x-go-package: bridge/s3_portal/base/s3_metadata.pb OutlookBackupEnvParams: description: 'Message to capture any additional backup params for Outlook within Office365 environment.' type: object title: Outlook Backup Environment Parameters. properties: filteringPolicy: description: 'The filtering policy describes which paths within a mailbox should be excluded within the backup. If this is not specified, then the entire Outlook mailbox will be backed up.' $ref: '#/components/schemas/FilteringPolicyProto' shouldBackupMailbox: description: 'Specifies whether the mailbox for all the Office365 Users present in the protection job should be backed up.' type: - boolean - 'null' x-go-name: ShouldBackupMailbox x-go-package: magneto/base/env_params.pb VMwareDiskExclusionProto: description: 'This message contains basic info of the disk to be excluded from backup. The info contained here: 1. should be enough to identify the disk during the backup job. 2. is a subset of the message fetched to be displayed to the end user. Example: entities/vmware.proto. Note: Currently this is only implemented for VMware type source.' type: object title: VMware Disk Exclusion Proto. properties: controllerBusNumber: description: Controller's bus-id controlling the virtual disk in question. type: - integer - 'null' format: int64 x-go-name: ControllerBusNumber controllerType: description: Controller's type (SCSI, IDE etc). type: - string - 'null' x-go-name: ControllerType unitNumber: description: Disk unit number to identify the virtual disk within a controller. type: - integer - 'null' format: int64 x-go-name: UnitNumber x-go-package: magneto/base/env_params.pb RdsParams: description: Specifies rds params for the restore operation. type: object title: RDS parameters. required: - dbInstanceId properties: availabilityZoneId: description: Entity representing the availability zone to use while restoring the DB. type: - integer - 'null' format: int64 x-go-name: AvailabilityZoneId dbInstanceId: description: 'The DB instance identifier to use for the restored DB. This field is required.' type: - string - 'null' x-go-name: DbInstanceId dbOptionGroupId: description: Entity representing the RDS option group to use while restoring the DB. type: - integer - 'null' format: int64 x-go-name: DbOptionGroupId dbParameterGroupId: description: Entity representing the RDS parameter group to use while restoring the DB. type: - integer - 'null' format: int64 x-go-name: DbParameterGroupId dbPort: description: Port to use for the DB in the restored RDS instance. type: - integer - 'null' format: int32 x-go-name: DbPort enableAutoMinorVersionUpgrade: description: Whether to enable auto minor version upgrade in the restored DB. type: - boolean - 'null' x-go-name: EnableAutoMinorVersionUpgrade enableCopyTagsToSnapshots: description: Whether to enable copying of tags to snapshots of the DB. type: - boolean - 'null' x-go-name: EnableCopyTagsToSnapshots enableDbAuthentication: description: Whether to enable IAM authentication for the DB. type: - boolean - 'null' x-go-name: EnableDbAuthentication enablePublicAccessibility: description: Whether this DB will be publicly accessible or not. type: - boolean - 'null' x-go-name: EnablePublicAccessibility isMultiAzDeployment: description: Whether this is a multi-az deployment or not. type: - boolean - 'null' x-go-name: IsMultiAzDeployment x-go-package: cohesity/iris/server/data/public DSESolrInfo: type: object title: Message to hold information about DSE Solr node. properties: solrNodeVec: description: Solr node IP Addresses. type: - array - 'null' items: type: string x-go-name: SolrNodeVec solrPort: description: Solr node Port. type: - integer - 'null' format: uint32 x-go-name: SolrPort x-go-package: magneto/base/nosql.pb 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 PhysicalFileBackupParams: description: Message to capture params when backing up files on a Physical source. type: object title: Physical File Backup Parameters. properties: backupPathInfoVec: description: Specifies the paths to backup on the Physical source. type: - array - 'null' items: $ref: '#/components/schemas/PhysicalFileBackupParams_BackupPathInfo' x-go-name: BackupPathInfoVec metadataFilePath: description: 'Specifies metadata path on source. This file contains absolute paths of files that needs to be backed up on the same source. If this field is set, backup_path_info_vec will be ignored.' type: - string - 'null' x-go-name: MetadataFilePath skipNestedVolumesVec: description: Mount types of nested volumes to be skipped. type: - array - 'null' items: type: string x-go-name: SkipNestedVolumesVec symlinkFollowNasTarget: description: 'Specifies whether to follow nas target pointed by symlink. Set to true only for windows physical file based job.' type: - boolean - 'null' x-go-name: SymlinkFollowNasTarget usesSkipNestedVolumesVec: description: 'Specifies whether to use skip_nested_volumes_vec to skip nested mounts. Before 6.4, BackupPathInfo.skip_nested_volumes boolean was used to skip nested volumes. So we use this boolean to support older jobs.' type: - boolean - 'null' x-go-name: UsesSkipNestedVolumesVec x-go-package: magneto/base/env_params.pb NodeToTieredStorageDirectoriesMap: type: object title: Mapping of each Cassandra node to a list of tiered storage directories. properties: cassandraNodeName: description: Name of the Cassandra node. type: - string - 'null' x-go-name: CassandraNodeName tieredStorageDirectoriesVec: description: Array of tiered storage directories. type: - array - 'null' items: type: string x-go-name: TieredStorageDirectoriesVec x-go-package: magneto/base/nosql.pb FixedUnixIdMapping: description: 'Specifies the fields when mapping type is set to ''kFixed''. It maps all Active Directory users of a domain to a fixed Unix uid, and gid.' type: object title: Fixed Unix ID Mapping. properties: gid: description: Specifies the fixed Unix GID, when mapping type is set to kFixed. type: - integer - 'null' format: int64 x-go-name: Gid uid: description: Specifies the fixed Unix UID, when mapping type is set to kFixed. type: - integer - 'null' format: int64 x-go-name: Uid 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 VMwareBackupEnvParams: description: Message to capture any additional backup params for a VMware environment. type: object title: VMware Backup Environment Parameters. properties: allowCrashConsistentSnapshot: description: 'Whether to fallback to take a crash-consistent snapshot incase taking an app-consistent snapshot fails.' type: - boolean - 'null' x-go-name: AllowCrashConsistentSnapshot allowNbdsslTransportFallback: description: 'Whether to fallback to use NBDSSL transport for backup in case using SAN transport backup fails.' type: - boolean - 'null' x-go-name: AllowNbdsslTransportFallback allowVmsWithPhysicalRdmDisks: description: 'Physical RDM disks cannot be backed up using VADP. By default the backups of such VMs will fail. If this is set to true, then such VMs in this backup job will be backed up by excluding the physical RDM disks.' type: - boolean - 'null' x-go-name: AllowVmsWithPhysicalRdmDisks vmwareDiskExclusionInfo: description: 'List of Virtual Disk(s) to be excluded from the backup job. These disks will be excluded for all VMs in this environment unless overriden by the disk exclusion list from BackupSourceParams.VMwareBackupSourceParams.' type: - array - 'null' items: $ref: '#/components/schemas/VMwareDiskExclusionProto' x-go-name: VmwareDiskExclusionInfo x-go-package: magneto/base/env_params.pb CouchbaseConnectParams: description: 'Specifies an Object containing information about a registered couchbase source.' type: object title: Couchbase Connect Params. properties: carrierDirectPort: description: Specifies the Carrier direct/sll port. type: - integer - 'null' format: int32 x-go-name: CarrierDirectPort httpDirectPort: description: Specifies the HTTP direct/sll port. type: - integer - 'null' format: int32 x-go-name: HttpDirectPort requiresSsl: description: Specifies whether this cluster allows connection through SSL only. type: - boolean - 'null' x-go-name: RequiresSsl seeds: description: Specifies the Seeds of this Couchbase Cluster. type: - array - 'null' items: type: string x-go-name: Seeds x-go-package: cohesity/iris/server/data/public DeployFleetParams: type: object title: Contains Fleet specific params. properties: awsFleetParams: description: Contains AWS Fleet specific params. $ref: '#/components/schemas/AWSFleetParams' x-go-package: magneto/base/cloud_deploy.pb AdditionalOracleDBParams: type: object title: Message to capture additional channel information for Oracle Database. properties: appEntityId: description: Database app id. type: - integer - 'null' format: int64 x-go-name: AppEntityId dbInfoChannelVec: description: 'The following proto message should be renamed to a more general message to represent parameters pertaining to a single unique Oracle database. Uniqueness of an Oracle database should be strictly determined by its database unique name. i.e. all backup parameters needed for a unique Oracle database should be expressed in the following proto. It is a vector for future support of backing up Data Guard sources. We may or may not need this to be vector to support Data Guard sources. For now, the size of this vector is always 1. When we rename this proto in the future, if we determine there is no need to use a vector for Data Guard support, we can choose to remove ''repeated''.' type: - array - 'null' items: $ref: '#/components/schemas/OracleDBChannelInfo' x-go-name: DbInfoChannelVec x-go-package: magneto/base/env_params.pb PhysicalFileBackupParams_BackupPathInfo: description: Describes a set of files rooted under a path that need to be backed up. type: object title: Backup Path Information. properties: excludePaths: description: 'A list of absolute paths on the Physical source that should not be backed up. Any path that is a descendant of these paths will also be skipped.' type: - array - 'null' items: type: string x-go-name: ExcludePaths includePath: description: 'An absolute path on the Physical source that should be backed up. Any path that is a descendant of this path will also be backed up, unless (a) it is excluded from backup by exclude_paths below, OR (b) it belongs to a volume that is different from the volume include_path belongs to and there are no relevant paths in that volume being backed up.' type: - string - 'null' x-go-name: IncludePath skipNestedVolumes: description: 'Whether to skip any nested volumes (both local and network) that are mounted under ''include_path''. Note that if a path to a nested volume is specified as an include_path in another BackupPathInfo entry, that path will still get backed up.' type: - boolean - 'null' x-go-name: SkipNestedVolumes x-go-package: magneto/base/env_params.pb BackupJobProto: type: object properties: abortInExclusionWindow: description: 'This field determines whether a backup run should be aborted when it hits an exclusion window (assuming that it was started earlier when it was not in an exclusion window).' type: - boolean - 'null' x-go-name: AbortInExclusionWindow alertingPolicy: description: Determines the alerting policy for jobs. $ref: '#/components/schemas/AlertingPolicyProto' backupQosPrincipal: description: The backup QoS principal to use for the backup job. type: - integer - 'null' format: int32 x-go-name: BackupQosPrincipal backupSourceParams: description: 'This contains additional backup params that are applicable to sources that are captured as part of the backup job. NOTE: The sources could point to higher level entities (such as a "Cluster" in VMware environment), but the source params captured here will not be for the matching higher level entity, but instead be for leaf-level entities (such as VMs).' type: - array - 'null' items: $ref: '#/components/schemas/BackupSourceParams' x-go-name: BackupSourceParams continueOnQuiesceFailure: description: Whether to continue backing up on quiesce failure. type: - boolean - 'null' x-go-name: ContinueOnQuiesceFailure createRemoteView: description: 'If set to false, a remote view will not be created. If set to true and: 1) Remote view name is not provided by the user, a remote view is created with the same name as source view name. 2) Remote view name is provided by the user, a remote view is created with the given name.' type: - boolean - 'null' x-go-name: CreateRemoteView dedupDisabledSourceIdVec: description: 'List of source ids for which source side dedup is disabled from the backup job.' type: - array - 'null' items: type: integer format: int64 x-go-name: DedupDisabledSourceIdVec deletionStatus: description: 'Determines if the job (and associated backups) should be deleted. Once a job has been deleted, its status cannot be changed.' type: - integer - 'null' format: int32 x-go-name: DeletionStatus description: description: Job description (as entered by the user). type: - string - 'null' x-go-name: Description drToCloudParams: $ref: '#/components/schemas/BackupJobProto_DRToCloudParams' ehParentSource: description: 'We need to send this to the Rx cluster via Replication or Remote restore to generate entity mappings correctly. NOTE: This field is set only by Magneto.' title: 'The parent source in entity hierarchy. This may be set for environments such as SQL and Oracle, where the ''parent_source'' may be a SQL/Oracle root container, while the real parent source in entity hierarchy might be a Physical container or a vCenter.' $ref: '#/components/schemas/EntityProto' endTimeUsecs: description: The time (in usecs) after which no backup for the job should be scheduled. type: - integer - 'null' format: int64 x-go-name: EndTimeUsecs envBackupParams: description: 'Job level additional environment specific backup params. If this is not specified, we will take default actions (for example for NAS environments, we will backup all objects within the source).' $ref: '#/components/schemas/EnvBackupParams' excludeSources: description: 'The list of sources to exclude from backups. These can have non-leaf-level entities, but it''s up to the creator to ensure that a child of these sources hasn''t been explicitly added to ''sources''.' type: - array - 'null' items: $ref: '#/components/schemas/BackupJobProto_ExcludeSource' x-go-name: ExcludeSources excludeSources_DEPRECATED: description: 'The list of sources to exclude from backups. These can have non-leaf-level entities, but it''s up to the creator to ensure that a child of these sources hasn''t been explicitly added to ''sources''.' type: - array - 'null' items: $ref: '#/components/schemas/EntityProto' x-go-name: ExcludeSources_DEPRECATED exclusionRanges: description: Do not run backups in these time-ranges. type: - array - 'null' items: $ref: '#/components/schemas/BackupJobProto_ExclusionTimeRange' x-go-name: ExclusionRanges fullBackupJobPolicy: description: Determines how often full backups should be run. $ref: '#/components/schemas/JobPolicyProto' fullBackupSlaTimeMins: description: 'Same as ''sla_time_mins'' above, but applies to full backups. NOTE: This value is considered only for full backups that are excepted i.e either scheduled or the first full backup and not for full backups that happen as a result of incremental backup failure.' type: - integer - 'null' format: int64 x-go-name: FullBackupSlaTimeMins globalIncludeExclude: description: 'Determines global include and exclude filters which are applied to all sources in a physical job.' $ref: '#/components/schemas/PhysicalFileBackupParams_GlobalIncludeExclude' indexingPolicy: description: 'Determines the indexing policy (in Yoda) for objects backed up by this job.' $ref: '#/components/schemas/IndexingPolicyProto' isActive: description: 'Whether the backup job is active or not. Details about what an active job is can be found here: https://goo.gl/1mLvS3.' type: - boolean - 'null' x-go-name: IsActive isContinuousSnapshottingEnabled: description: 'Indicates if Magneto should continue taking source snapshots even if there is a pending run.' type: - boolean - 'null' x-go-name: IsContinuousSnapshottingEnabled isDeleted: description: Tracks whether the backup job has actually been deleted. type: - boolean - 'null' x-go-name: IsDeleted isDirectArchiveEnabled: description: This field is set to true if this is a direct archive backup job. type: - boolean - 'null' x-go-name: IsDirectArchiveEnabled isDirectArchiveNativeFormatEnabled: description: 'This field is set to true if native format should be used for archiving. Applicable for only direct archive jobs.' type: - boolean - 'null' x-go-name: IsDirectArchiveNativeFormatEnabled isPaused: description: 'Whether the backup job is paused. New backup runs are not scheduled for the paused backup job. Active run of a backup job (if any) is not impacted.' type: - boolean - 'null' x-go-name: IsPaused isRpoJob: description: 'Whether the backup job is an RPO policy job. These jobs are hidden from the user, and are created internally to have a backup schedule for the given source.' type: - boolean - 'null' x-go-name: IsRpoJob jobCreationTimeUsecs: description: Time when this job was first created. type: - integer - 'null' format: int64 x-go-name: JobCreationTimeUsecs jobId: description: 'A unique id for locally created jobs. This should only be used to identify jobs created on the local cluster. When Iris communicates with Magneto, Iris can continue to use this job_id field, which will always be assumed to refer to locally created jobs. For remotely created jobs, the ''job_uid'' field should be used. The only time Iris should ever need to refer to a remote job is when restoring an object from a remote snapshot. In all such cases, Iris should use the job_uid field.' type: - integer - 'null' format: int64 x-go-name: JobId jobPolicy: description: 'Determines how often the job should run and how long the snapshots of the job should be retained at various targets.' $ref: '#/components/schemas/JobPolicyProto' jobUid: description: The globally unique id of the job. $ref: '#/components/schemas/UniversalIdProto' lastModificationTimeUsecs: description: Time when this job description was last updated. type: - integer - 'null' format: int64 x-go-name: LastModificationTimeUsecs lastPauseModificationTimeUsecs: description: Time when the job was last paused or unpaused. type: - integer - 'null' format: int64 x-go-name: LastPauseModificationTimeUsecs lastPauseReason: description: 'Last reason for pausing the backup job. Capturing the reason will help in resuming only the jobs that were paused because of a reason once the reason for pausing is not applicable.' type: - integer - 'null' format: int32 x-go-name: LastPauseReason lastUpdatedUsername: description: The user who modified the job most recently. type: - string - 'null' x-go-name: LastUpdatedUsername leverageSanTransport: description: 'This is set to true by the user in order to backup the objects via a dedicated storage area network (SAN), as opposed to transport via LAN or management network. NOTE: Not all adapters support this method. Currently only VMware.' type: - boolean - 'null' x-go-name: LeverageSanTransport leverageStorageSnapshots: description: 'Whether to leverage the storage array based snapshots for this backup job. To leverage storage snapshots, the storage array has to be registered as a source. If storage based snapshots can not be taken, job will fallback to the default backup method. NOTE: This will be set for Pure snapshots.' type: - boolean - 'null' x-go-name: LeverageStorageSnapshots leverageStorageSnapshotsForHyperflex: description: 'This is set to true by the user if hyperflex snapshots are requested NOTE: If this is set to true, then leverage_storage_snapshots above should be false.' type: - boolean - 'null' x-go-name: LeverageStorageSnapshotsForHyperflex logBackupJobPolicy: description: Determines how often log backups should be run (for SQL jobs). $ref: '#/components/schemas/JobPolicyProto' maxAllowedSourceSnapshots: description: 'Determines the maximum number of source snapshots allowed for a given entity in the job. This is only applicable if ''is_continuous_snapshotting_enabled'' is set to true.' type: - integer - 'null' format: int32 x-go-name: MaxAllowedSourceSnapshots name: description: The name of this backup job. This must be unique across all jobs. type: - string - 'null' x-go-name: Name numSnapshotsToKeepOnPrimary: description: 'Specifies how many recent snapshots of each backed up entity to retain on the primary environment. If not specified, then snapshots will not be be deleted from the primary environment. NOTE: This is only applicable for certain environments like kPure.' type: - integer - 'null' format: int64 x-go-name: NumSnapshotsToKeepOnPrimary parentSource: description: The registered source managing all the sources being backed up. $ref: '#/components/schemas/EntityProto' performSourceSideDedup: description: Whether or not to perform source side dedup. type: - boolean - 'null' x-go-name: PerformSourceSideDedup policyAppliedTimeMsecs: description: 'Epoch time in milliseconds when the policy was last applied to this job. This field will be used to determine whether a policy has changed after it was applied to a particular job.' type: - integer - 'null' format: int64 x-go-name: PolicyAppliedTimeMsecs policyId: description: 'Id of the policy being applied to the backup job. It is expected to be of the form "cluster_id:cluster_instance_id:local_identifier".' type: - string - 'null' x-go-name: PolicyId policyName: description: 'The name of the policy referred to by policy_uid. This field can be stale and should not be relied upon for the latest name.' type: - string - 'null' x-go-name: PolicyName postBackupScript: description: Post backup script associated with the backup job. $ref: '#/components/schemas/BackupJobPreOrPostScript' preScript: description: 'Pre script associated with the backup job. This field must be specified for ''kPuppeteer'' job.' $ref: '#/components/schemas/BackupJobPreOrPostScript' primaryJobUid: description: 'The globally unique id of the original remote job from which this job was derived.' $ref: '#/components/schemas/UniversalIdProto' priority: description: 'The priority for the job. This is used at admission time - all admitted jobs are treated equally. This is also used to determine the Madrox replication priority.' type: - integer - 'null' format: int32 x-go-name: Priority quiesce: description: 'Whether to take app-consistent snapshots by quiescing apps and the filesystem before taking a backup.' type: - boolean - 'null' x-go-name: Quiesce remoteJobUids: description: 'The globally unique ids of all remote jobs that are linked to this job (because of incoming replications). This field will only be populated for locally created jobs. This field is populated only for the local(stub) job during incoming replications. In the most common case of one cluster replicating to another, this field will only have one entry (which is the id of the job on Tx side) and matches the primary_job_uid. This will have multiple entries in the following situation: A->B, A->C replication. The backup is failed over to B, and B now starts replicating to C. In this case, the stub job at C will have two entries. One is the job id from cluster A, and another is the local(stub) job uid from B. Also note that since the job originated from A, primary_job_uid for all the replicated instances of this job across multiple clusters will remain the same (which is equal to the job id from the original cluster A).' type: - array - 'null' items: $ref: '#/components/schemas/UniversalIdProto' x-go-name: RemoteJobUids remoteViewName: description: 'A human readable name of the remote view. A remote view is created with name overwriting the latest snapshot.' type: - string - 'null' x-go-name: RemoteViewName requiredFeatureVec: description: 'The features that are strictly required to be supported by the cluster of the backup job. This is currently used in the following cases: 1. Tx cluster looks at the Rx cluster''s supported features and replicates the backup job only if all the features captured here are supported. 2. When performing remote restore of a backup job from an archival, this job will be retrieved only if the cluster supports all the features listed here.' type: - array - 'null' items: type: string x-go-name: RequiredFeatureVec slaTimeMins: description: 'If specified, this variable determines the amount of time (after backup has started) in which backup is expected to finish for this job. An SLA violation is counted against this job if the amount of time taken exceeds this amount.' type: - integer - 'null' format: int64 x-go-name: SlaTimeMins sourceFilters: description: 'Determines include and exclude filters which are applied to entities in a backup source. For SQL, this will be applicable only for auto protect sources.' $ref: '#/components/schemas/SourceFilters' sources: description: 'The list of sources that should be backed up. A source in this list could be a descendant of another source in the list (this will be used when specifying override backup schedules).' type: - array - 'null' items: $ref: '#/components/schemas/BackupJobProto_BackupSource' x-go-name: Sources startTime: description: 'The time when the backup runs for the job should start. This is only applicable if the policy for the job has a daily or monthly schedule.' $ref: '#/components/schemas/Time' stubbingPolicy: description: Scheduling and retention policy for stubbing jobs. $ref: '#/components/schemas/StubbingPolicyProto' tagVec: description: 'Tags associated with the job. User can specify tags/keywords that can indexed by Yoda and can be later searched in UI. For example, user can create a ''kPuppeteer'' job to backup Oracle DB for ''payroll'' department. User can specify following tags: ''payroll'', ''Oracle_DB''.' type: - array - 'null' items: type: string x-go-name: TagVec timezone: description: 'Timezone of the backup job. All time fields (i.e., TimeOfDay) in this backup job are stored wrt to this timezone. The time zones have unique names of the form "Area/Location", e.g. "America/New_York". We are using "America/Los_Angeles" as a default value so as to be backward compatible with pre-2.7 code.' type: - string - 'null' x-go-name: Timezone truncateLogs: description: 'Whether to truncate logs after a backup run. This is currently only relevant for full or incremental backups in a SQL environment.' type: - boolean - 'null' x-go-name: TruncateLogs type: description: The type of environment this backup job corresponds to. type: - integer - 'null' format: int32 x-go-name: Type userInfo: description: Information if any about the user that owns this job. $ref: '#/components/schemas/UserInformation' viewBoxId: description: The view box to which data will be written. type: - integer - 'null' format: int64 x-go-name: ViewBoxId x-go-package: magneto/base/magneto.pb ViewProtection: description: 'Specifies information about the Protection Jobs that are protecting the View.' type: object title: View Protection. properties: inactive: description: 'Specifies if this View is an inactive View that was created on this Remote Cluster to store the Snapshots created by replication. This inactive View cannot be NFS or SMB mounted.' type: - boolean - 'null' x-go-name: Inactive magnetoEntityId: description: Specifies the id of the Protection Source that is using this View. type: - integer - 'null' format: int64 x-go-name: MagnetoEntityId protectionJobs: description: 'Array of Protection Jobs. Specifies the Protection Jobs that are protecting the View.' type: - array - 'null' items: $ref: '#/components/schemas/ProtectionJobInfo' x-go-name: ProtectionJobs x-go-package: cohesity/iris/server/data/public HdfsBackupJobParams: description: 'Contains any additional hdfs environment specific backup params at the job level.' type: object properties: hdfsExcludePattern: description: Any path/Glob pattern from HDFS that is to excluded. type: - array - 'null' items: type: string x-go-name: HdfsExcludePattern hdfsProtectPattern: description: Any path/Glob pattern from HDFS that is to protected. type: - array - 'null' items: type: string x-go-name: HdfsProtectPattern x-go-package: magneto/base/nosql.pb BackupJobProto_ExclusionTimeRange: description: 'A proto to specify a time range within a single day when backups are not permitted to run.' type: object properties: day: description: If the day is not set, the time range applies to all days. type: - integer - 'null' format: int32 x-go-name: Day endTime: description: End time of the time range. $ref: '#/components/schemas/Time' startTime: description: Start time of the time range. $ref: '#/components/schemas/Time' x-go-package: magneto/base/magneto.pb 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 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 BackupPolicyProto_ContinuousSchedule: type: object properties: backupIntervalMins: description: 'If this field is set, backups will be performed periodically every ''interval_mins'' number of minutes. NOTE: This is the interval between the start time of two successive backups.' type: - integer - 'null' format: int64 x-go-name: BackupIntervalMins exclusionRanges: description: 'Do not start backups in these time-ranges. It''s possible for a previously started backup to spill over into an exclusion range. NOTE: This field has been deprecated. Use the exclusion_ranges field defined within BackupPolicyProto instead.' type: - array - 'null' items: $ref: '#/components/schemas/BackupPolicyProto_ExclusionTimeRange' x-go-name: ExclusionRanges x-go-package: magneto/base/magneto.pb 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 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 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 ReplicateSnapshotsToAWSParams: description: 'Params required to replicate snapshots to another AWS source. This is populated for AWS snapshot manager replication.' type: object properties: region: description: Name of the AWS region in which to replicate the snapshots. $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/cloud_deploy.pb BackupSourceParams: description: Message to capture any additional backup params at the source level. type: object title: Backup Source Parameters. properties: appEntityIdVec: description: 'If we are backing up an application (such as SQL), this contains the entity ids of the app entities (such as SQL instances and databases) that will be protected on the backup source. If this vector is empty, it implies that we are protecting all app entities on the source.' type: - array - 'null' items: type: integer format: int64 x-go-name: AppEntityIdVec oracleParams: description: 'This is applicable to sources of type kOracle databases. These are additional backup parameters for kOracle.' $ref: '#/components/schemas/OracleSourceParams' physicalParams: description: This is applicable to sources of type kHost (kPhysical environment). $ref: '#/components/schemas/PhysicalBackupSourceParams' skipIndexing: description: Set to true, if indexing is not required for given source. type: - boolean - 'null' x-go-name: SkipIndexing sourceId: description: 'Source entity id. NOTE: This is expected to point to a leaf-level entity.' type: - integer - 'null' format: int64 x-go-name: SourceId vmwareParams: description: 'This is applicable to sources of type kVirtualMachine (kVMware environment).' $ref: '#/components/schemas/VMwareBackupSourceParams' x-go-package: magneto/base/env_params.pb 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 UniversalIdProto: type: object properties: clusterId: description: The id of the cluster at which the object was created. type: - integer - 'null' format: int64 x-go-name: ClusterId clusterIncarnationId: description: The incarnation id of the above cluster. type: - integer - 'null' format: int64 x-go-name: ClusterIncarnationId objectId: description: The object id - this is unique within the above cluster. type: - integer - 'null' format: int64 x-go-name: ObjectId x-go-package: util/base/universal_id.pb HyperVBackupEnvParams: description: Message to capture any additional backup params for a HyperV environment. type: object title: HyperV Backup Environment Parameters. properties: allowCrashConsistentSnapshot: description: 'Whether to fallback to take a crash-consistent snapshot incase taking an app-consistent snapshot fails.' type: - boolean - 'null' x-go-name: AllowCrashConsistentSnapshot backupJobType: description: 'The type of backup job to use. Default is to auto-detect the best type to use based on the VMs to backup. End user may select RCT or VSS also.' type: - integer - 'null' format: int32 x-go-name: BackupJobType x-go-package: magneto/base/env_params.pb ACLProto: description: 'Protobuf that describes the access control list (ACL) permissions for a bucket or for an object.' type: object properties: commonAcl: description: CommonACL of the Swift container. $ref: '#/components/schemas/CommonACLProto' grantVec: type: - array - 'null' items: $ref: '#/components/schemas/ACLProto_Grant' x-go-name: GrantVec keystoneAcl: description: KeystoneACL of the Swift container. $ref: '#/components/schemas/KeystoneACLProto' swiftReadAcl: description: Swift ACL strings. type: - string - 'null' x-go-name: SwiftReadAcl swiftWriteAcl: type: - string - 'null' x-go-name: SwiftWriteAcl x-go-package: bridge/s3_portal/base/s3_metadata.pb SchedulingPolicyProto_DailySchedule: description: 'Sample protos: Every n days (n >= 1) Ex: For every 2 days, { frequency : 2 } Weekly schedule (Few selected weekdays) Ex: For every Monday, Tuesday { days : {kMonday, kTuesday} } NOTE: Only one of the ''days'' and ''frequency'' should be populated.' type: object title: The daily schedule encompasses below 2 types of schedules. properties: days: description: 'The list of weekdays for scheduling a backup. This is populated only for selected weekday schedules.' type: - array - 'null' items: type: integer format: int32 x-go-name: Days frequency: description: This is set only for every-n-day schedules. type: - integer - 'null' format: int64 x-go-name: Frequency x-go-package: magneto/base/policy.pb CassandraConnectParams: description: 'Specifies an Object containing information about a registered cassandra source.' type: object title: Cassandra Connect Params. properties: cassandraPortsInfo: description: Specifies the ports related info. $ref: '#/components/schemas/CassandraPortsInfo' cassandraSecurityInfo: description: Specifies the security related info. $ref: '#/components/schemas/CassandraSecurityInfo' cassandraVersion: description: Cassandra version type: - string - 'null' x-go-name: CassandraVersion configDirectory: description: Specifies the Directory path containing Config YAML for discovery. type: - string - 'null' x-go-name: ConfigDirectory dataCenters: description: 'Specifies the List of all physical data center or virtual data center. In most cases, the data centers will be listed after discovery operation however, if they are not listed, you must manually type the data center names. Leaving the field blank will disallow data center-specific backup or restore. Entering a subset of all data centers may cause problems in data movement.' type: - array - 'null' items: type: string x-go-name: DataCenters dseConfigDirectory: description: Specifies the Directory from where DSE specific configuration can be read. type: - string - 'null' x-go-name: DseConfigDirectory isDseAuthenticator: description: Specifies whether this cluster has DSE Authenticator. type: - boolean - 'null' x-go-name: IsDseAuthenticator isDseTieredStorage: description: Specifies whether this cluster has DSE tiered storage. type: - boolean - 'null' x-go-name: IsDseTieredStorage isJmxAuthEnable: description: Specifies if JMX Authentication enabled in this cluster. type: - boolean - 'null' x-go-name: IsJmxAuthEnable kerberosPrincipal: description: Specifies the Kerberos Principal for Kerberos connection type: - string - 'null' x-go-name: KerberosPrincipal primaryHost: description: Specifies the Primary Host for the Cassandra cluster. type: - string - 'null' x-go-name: PrimaryHost seeds: description: Specifies the Seed nodes of this Cassandra cluster. type: - array - 'null' items: type: string x-go-name: Seeds solrNodes: description: Specifies the Solr node IP Addresses type: - array - 'null' items: type: string x-go-name: SolrNodes solrPort: description: Specifies the Solr node Port. type: - integer - 'null' format: int32 x-go-name: SolrPort x-go-package: cohesity/iris/server/data/public GcpParams: description: Specifies various resources when converting and deploying a VM to GCP. type: object title: GCP Parameters. properties: instanceId: description: Specifies id of the GCP instance type in which to deploy the VM. type: - integer - 'null' format: int64 x-go-name: ProjectId region: description: Specifies id of the GCP region in which to deploy the VM. type: - integer - 'null' format: int64 x-go-name: RegionId subnetId: description: Specifies id of the subnet within above VPC. type: - integer - 'null' format: int64 x-go-name: Subnet virtualPrivateCloudId: description: Specifies id of the Virtual Private Cloud to chose for the instance type. type: - integer - 'null' format: int64 x-go-name: Zone x-go-package: cohesity/iris/server/data/public PhysicalSnapshotParams: description: 'This message contains params that controls the snapshot process for a physical host.' type: object properties: fetchSnapshotMetadataDisabled: description: Whether fetching and storing of snapshot metadata was disabled. type: - boolean - 'null' x-go-name: FetchSnapshotMetadataDisabled notifyBackupCompleteDisabled: description: Whether notify backup complete step was disabled. type: - boolean - 'null' x-go-name: NotifyBackupCompleteDisabled vssCopyOnlyBackup: description: If copy_only_backup option is requrested at the time of the snapshot. type: - boolean - 'null' x-go-name: VssCopyOnlyBackup vssExcludedWriters: description: List of VSS writers that were excluded. type: - array - 'null' items: type: string x-go-name: VssExcludedWriters x-go-package: magneto/base/env_params.pb Project: type: object title: Keystone project proto. properties: domain: description: Domain to which the project is scoped. $ref: '#/components/schemas/Domain' domainId: description: 'The ID of the domain to which the project is scoped. This field is used in the reponse of Keystone API.' type: - string - 'null' x-go-name: DomainId id: description: The ID of the project. type: - string - 'null' x-go-name: Id name: description: The name of the project. type: - string - 'null' x-go-name: Name x-go-package: bridge/s3_portal/keystone/keystone2.pb 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 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 DeployVMsToAzureParams: description: 'Contains Azure specific information needed to identify various resources when converting and deploying a VM to Azure.' type: object properties: azureManagedDiskParams: description: Managed disk parameter if deployment is using managed disks. $ref: '#/components/schemas/AzureManagedDiskParams' computeOptions: description: Type of VM (e.g. small, medium, large) when cloning the VM in Azure. $ref: '#/components/schemas/EntityProto' networkResourceGroup: description: 'Name of the Azure resource group that has the virtual network mentioned below.' $ref: '#/components/schemas/EntityProto' networkSecurityGroup: description: 'Name of the network security group. It''s location should be same as the storage account.' $ref: '#/components/schemas/EntityProto' resourceGroup: description: 'Name of the Azure resource group. Its value is globally unique within Azure.' $ref: '#/components/schemas/EntityProto' storageAccount: description: 'Name of the storage account that will contain the storage container within which we will create the blob that will become the VHD disk for the cloned VM.' $ref: '#/components/schemas/EntityProto' storageContainer: description: Name of the storage container within the above storage account. $ref: '#/components/schemas/EntityProto' storageKey: description: The storage key for the above storage account. $ref: '#/components/schemas/EntityProto' storageResourceGroup: description: 'Name of the Azure resource group that has the storage account mentioned below.' $ref: '#/components/schemas/EntityProto' subnet: description: Name of the subnet within the above virtual network. $ref: '#/components/schemas/EntityProto' tempVmResourceGroup: description: Name of the resource group where the temporary VM needs to be created. title: 'Next few fields are for getting additional resources for creating temporary resources in Azure to create a temporary VM to convert the VM so that the guest VM will be Azure Compatible. The values are optional for customer to provide.' $ref: '#/components/schemas/EntityProto' tempVmStorageAccount: description: Name of the Storage Account where the temporary VM needs to be created. $ref: '#/components/schemas/EntityProto' tempVmStorageContainer: description: 'Name of the Storage container where the temporary VM''s OS Disk needs to be created.' $ref: '#/components/schemas/EntityProto' tempVmSubnet: description: 'Name of the Subnet within the temp_vm_virtual_network where the temporary vm needs to be created.' $ref: '#/components/schemas/EntityProto' tempVmVirtualNetwork: description: Name of the Virtual Network where the temporary VM needs to be created. $ref: '#/components/schemas/EntityProto' virtualNetwork: description: Name of the Virtual Network. $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/cloud_deploy.pb 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 FilteringPolicyProto: description: 'Proto to encapsulate the filtering policy for backup objects like files or directories. If an object is not matched by any of the ''allow_filters'', it will be excluded in the backup. If an object is matched by one of the ''deny_filters'', it will always be excluded in the backup. Basically ''deny_filters'' overwrite ''allow_filters'' if they both match the same object. Currently we only support two kinds of filter: prefix which always starts with ''/'', or postfix which always starts with ''*'' (cannot be "*" only). We don''t support regular expression right now. A concrete example is: Allow filters: "/" Deny filters: "/tmp", "*.mp4" Using such a policy will include everything under the root directory except the /tmp directory and all the mp4 files.' type: object title: Filtering Policy Proto. properties: allowFilters: description: List of filters to allow matched objects for backup. type: - array - 'null' items: type: string x-go-name: AllowFilters denyFilters: description: List of filters to deny matched objects for backup. type: - array - 'null' items: type: string x-go-name: DenyFilters x-go-package: magneto/base/env_params.pb Value_Data: description: 'Specifies the fields to store data of a given type. Specify data in the appropriate field for the current data type.' type: object title: Data. properties: bytesValue: description: 'Specifies the field to store an array of bytes if the current data type is bytes. Specify a value for this field when type is equal to 4.' type: - array - 'null' items: type: integer format: uint8 x-go-name: BytesValue doubleValue: description: 'Specifies the field to store data if the current data type is a double value. Specify a value for this field when type is equal to 2.' type: - number - 'null' format: double x-go-name: DoubleValue int64Value: description: 'Specifies the field to store data if the current data type is a int64 value. Specify a value for this field when type is equal to 1.' type: - integer - 'null' format: int64 x-go-name: Int64Value stringValue: description: 'Specifies the field to store data if the current data type is a string value. Specify a value for this field when type is equal to 3.' type: - string - 'null' x-go-name: StringValue x-go-package: stats/base/stats_types.pb GdprCopyTask: description: CopyTask defines the copy tasks of a job. type: object title: GDPR Copy Task. properties: JobId: description: 'Specifies the job with which this copy task is tied to. Note: this is only used for internal aggregation.' type: - integer - 'null' format: int64 cloudTargetType: description: 'Specifies the cloud deploy target type. For example ''kAzure'',''kAWS'', ''kGCP''' type: - string - 'null' x-go-name: CloudTargetType expiryTimeUsecs: description: Specifies the expiry of the copy task. type: - integer - 'null' format: int64 x-go-name: ExpiryTimeUsecs targetId: description: Specifies the id for the target. type: - integer - 'null' format: int64 x-go-name: TargetId targetName: description: Specifies the target of the replication or archival tasks. type: - string - 'null' x-go-name: TargetName totalSnapshots: description: Specifies the total number of snapshots. type: - integer - 'null' format: int64 x-go-name: TotalSnapshots type: description: 'Specifies details about the Copy Run of a Job Run. A Copy task copies snapshots resulted from a backup run to an external target which could be ''kLocal'', ''kArchival'', or ''kRemote''.' type: - string - 'null' x-go-name: Type 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 ActiveDirectoryEntry: description: Specifies the join settings for a Microsoft Active Directory domain. type: object title: Active Directory. properties: domainName: description: Specifies the fully qualified domain name (FQDN) of an Active Directory. type: - string - 'null' x-go-name: DomainName fallbackUserIdMappingInfo: description: 'Specifies the fallback id mapping info which is used when an ID mapping for a user is not found via the above IdMappingInfo. Only supported for two types of fallback mapping types - ''kRid'' and ''kFixed''.' $ref: '#/components/schemas/UserIdMapping' ignoredTrustedDomains: description: 'Specifies the list of trusted domains that were set by the user to be ignored during trusted domain discovery.' type: - array - 'null' items: type: string x-go-name: IgnoredTrustedDomains ldapProviderId: description: Specifies the LDAP provider id which is map to this Active Directory type: - integer - 'null' format: int64 x-go-name: LdapProviderId machineAccounts: description: 'Array of Machine Accounts. Specifies an array of computer names used to identify the Cohesity Cluster on the domain.' type: - array - 'null' items: type: string x-go-name: MachineAccounts ouName: description: Specifies an optional Organizational Unit name. type: - string - 'null' x-go-name: OuName password: description: Specifies the password for the specified userName. type: - string - 'null' x-go-name: Password preferredDomainControllers: description: 'Specifies Map of Active Directory domain names to its preferred domain controllers.' type: - array - 'null' items: $ref: '#/components/schemas/PreferredDomainController' x-go-name: PreferredDomainControllers taskPath: description: Specifies the task path for AD joining task. type: - string - 'null' x-go-name: TaskPath tenantId: description: Specifies the unique id of the tenant. type: - string - 'null' x-go-name: TenantId trustedDomains: description: Specifies the trusted domains of the Active Directory domain. type: - array - 'null' items: type: string x-go-name: TrustedDomains readOnly: true trustedDomainsEnabled: description: Specifies whether Trusted Domain discovery is disabled. type: - boolean - 'null' x-go-name: TrustedDomainsEnabled unixRootSid: description: 'Specifies the SID of the Active Directory domain user to be mapped to Unix root user.' type: - string - 'null' x-go-name: UnixRootSid userIdMappingInfo: description: 'Specifies the information about how the Unix and Windows users are mapped for this domain.' $ref: '#/components/schemas/UserIdMapping' userName: description: Specifies a userName that has administrative privileges in the domain. type: - string - 'null' x-go-name: UserName workgroup: description: Specifies an optional Workgroup name. type: - string - 'null' x-go-name: Workgroup 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 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 NasBackupParams: description: Message to capture any additional backup params for a NAS environment. type: object title: NAS Backup Parameters. properties: backupExistingSnapshot: description: 'This bool parameter will be set only for DP volumes when customer doesn''t select the full_backup_snapshot_label and incremental_backup_snapshot_label. When set to true, backend will be using existing oldest snapshot for the first backup. Each incremental will be selected in ascending of snapshot create time on the source.' type: - boolean - 'null' x-go-name: BackupExistingSnapshot blacklistedIpAddrs: description: A list of IP addresses that should not be used. type: - array - 'null' items: type: string x-go-name: BlacklistedIpAddrs continueOnError: description: 'Whether the backup job should continue on errors for snapshot based backups. For non-snapshot-based generic NAS backup jobs, Magneto always continues on errors.' type: - boolean - 'null' x-go-name: ContinueOnError encryptionEnabled: description: Whether this backup job should use encryption. type: - boolean - 'null' x-go-name: EncryptionEnabled filteringPolicy: description: 'The filtering policy to decide which objects within a source should be backed up. If this is not specified, then all of the objects within the source will be backed up.' $ref: '#/components/schemas/FilteringPolicyProto' fldConfig: description: 'File level data lock configuration. To support File DataLock functionality similar to Netapp SnapLock, the following fields will be required from the user. This is same as what Cohesity as a filer offers for File DataLock.' $ref: '#/components/schemas/ViewIdMappingProto_FileLevelDataLockConfig' fullBackupSnapshotLabel: description: 'Only used when we backup using discovered snapshots. This prefix is to figure out which discovered snapshot we need to use for full backup.' type: - string - 'null' x-go-name: FullBackupSnapshotLabel incrementalBackupSnapshotLabel: description: 'Only used when we backup using discovered snapshots. This prefix is to figure out which discovered snapshot we need to use for incremental backup.' type: - string - 'null' x-go-name: IncrementalBackupSnapshotLabel isSourceInitiatedBackup: description: 'Source initiated backup when the source sends pushes the data like for example snapmirror based backup for netapp.' type: - boolean - 'null' x-go-name: IsSourceInitiatedBackup mixedModePreference: description: 'If the target entity is a mixed mode volume, which NAS protocol type the user prefer to backup. This does not apply to generic NAS and will be ignored.' type: - integer - 'null' format: int32 x-go-name: MixedModePreference s3Viewbackupproperties: description: This message captures all the details of S3 view. $ref: '#/components/schemas/S3ViewBackupProperties' snapshotChangeEnabled: description: 'Whether this backup job should utilize changelist like API when available for faster incremental backups.' type: - boolean - 'null' x-go-name: SnapshotChangeEnabled x-go-package: magneto/base/env_params.pb BackupPolicyProto_DailySchedule: description: 'The daily schedule encompasses weekly schedules as well. This has been done so there is only one way of specifying a schedule (backing up daily is the same as backing up weekly, but on all days of the week).' type: object properties: days: description: 'The days of the week backup must be performed. If no days are specified, then the backup will be performed on all days.' type: - array - 'null' items: type: integer format: int32 x-go-name: Days time: description: The time when daily backups should be performed. $ref: '#/components/schemas/Time' x-go-package: magneto/base/magneto.pb 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 DataTransferToVaultPerProtectionJob: description: 'Specifies statistics about the transfer of data from this Cohesity Cluster to this Vault for a Protection Job.' type: object title: Data Transfer to Vault Per Protection Job. properties: numLogicalBytesTransferred: description: 'Specifies the total number of logical bytes that are transferred from this Cohesity Cluster to this Vault for this Protection Job. The logical size is when the data is fully hydrated or expanded.' type: - integer - 'null' format: int64 x-go-name: NumLogicalBytesTransferred numPhysicalBytesTransferred: description: 'Specifies the total number of physical bytes that are transferred from this Cohesity Cluster to this Vault for this Protection Job.' type: - integer - 'null' format: int64 x-go-name: NumPhysicalBytesTransferred protectionJobName: description: Specifies the name of the Protection Job. type: - string - 'null' x-go-name: ProtectionJobName storageConsumed: description: 'Specifies the total number of storage bytes consumed that are transferred from this Cohesity Cluster to this vault for this Protection Job.' type: - integer - 'null' format: int64 x-go-name: StorageConsumed x-go-package: cohesity/iris/server/data/public DeployVMsToGCPParams: description: 'Contains GCP specific information needed to identify various resources when converting and deploying a VM to GCP.' type: object properties: projectId: description: Project id in which to deploy the VM. $ref: '#/components/schemas/EntityProto' region: description: Region in which to deploy the VM. $ref: '#/components/schemas/EntityProto' subnet: description: 'Name of the subnet in which to deploy the VM. The name of the VPC netowrk can be obtained from this subnet entity.' $ref: '#/components/schemas/EntityProto' zone: description: Zone in which to deploy the VM. $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/cloud_deploy.pb 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 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 HBaseBackupJobParams: description: 'Contains any additional hbase environment specific backup params at the job level.' type: object properties: hdfsConnectParams: description: Additional hdfs connection params required for HBase Backup. $ref: '#/components/schemas/HdfsConnectParams' x-go-package: magneto/base/nosql.pb ReplicateSnapshotsToAzureParams: description: This is populated for Azure snapshot manager replication. type: object title: Params required to replicate snapshots to another Azure's storage container. properties: resourceGroup: description: Resource group to filter regions in UX. $ref: '#/components/schemas/EntityProto' storageAccount: description: 'Name of the storage account that will contain the storage container within which we will create the blob/snapshot.' $ref: '#/components/schemas/EntityProto' storageContainer: description: Name of the storage container within the above storage account. $ref: '#/components/schemas/EntityProto' storageResourceGroup: description: 'Name of the Azure resource group that has the storage account mentioned below.' $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/cloud_deploy.pb BackupJobProto_ExcludeSource: type: object properties: entities: description: 'An intersection of leaf-level entities will be obtained after expanding the following entities.' type: - array - 'null' items: $ref: '#/components/schemas/EntityProto' x-go-name: Entities x-go-package: magneto/base/magneto.pb DeliveryRuleProto_DeliveryTarget: description: 'Delivery targets for the notifications. For now only email delivery is supported. In future, we can potentially add other delivery targets such as paging, SMS, etc.' type: object properties: emailAddress: description: List of email addresses to send notifications. type: - string - 'null' x-go-name: EmailAddress emailRecipientType: type: - integer - 'null' format: int32 x-go-name: EmailRecipientType externalApiCurlOptions: description: Specifies the curl options used to invoke above rest external api. type: - string - 'null' x-go-name: ExternalApiCurlOptions externalApiUrl: description: 'Specifies the external api to be invoked when an alert matching this rule is raised.' type: - string - 'null' x-go-name: ExternalApiUrl locale: description: Locale for the delivery target. type: - string - 'null' x-go-name: Locale snmpNotification: description: Need to send snmp notification for matched alerts. type: - boolean - 'null' x-go-name: SnmpNotification syslogNotification: description: Need to write syslog for matched alerts. type: - boolean - 'null' x-go-name: SyslogNotification tenantId: description: 'Tenant who has been assigned this target. This field is not populated within AlertsDataProto persisted in Gandalf. This is a convenience field and is populated on the fly by the Alerts component for delivery targets in the delivery_target_list within AlertProto. This field is utilized by NotificationDeliveryHelper to group delivery targets so that we could send out a single email to all the email addresses registered with the same locale by a given tenant or by the SP admin. Another approach could have been to use an internal object, but since the AlertProto contains a list of type DeliveryTarget, this field has been added to make it convenient to pass around an AlertProto object.' type: - string - 'null' x-go-name: TenantId x-go-package: alerts/base/alert.pb FileUptieringParams: type: object title: File Uptiering Parameters for NAS migration. properties: fileSelectPolicy: description: File uptier policy based on file access/modify time. type: - integer - 'null' format: int32 x-go-name: FileSelectPolicy fileSize: description: 'Gives the size criteria to be used for selecting the files to be uptiered. The hot files, which are greater or smaller than file_size, are uptiered.' type: - integer - 'null' format: int64 x-go-name: FileSize fileSizePolicy: description: File size policy for selecting files to uptier. type: - integer - 'null' format: int32 x-go-name: FileSizePolicy hotFileWindow: description: 'Identifies the hot files in the view. Files which are accessed num_file_access times in hot_file_window msecs, are uptiered. It is only applicable when file_select_policy is kLastAccessed and num_file_access is greater than 1.' type: - integer - 'null' format: int64 x-go-name: HotFileWindow nfsMountPath: description: 'Mount path where the Cohesity target view is mounted on NFS clients while migrating the data.' type: - string - 'null' x-go-name: NfsMountPath numFileAccess: description: 'Number of times file must be accessed within hot_file_window in order to qualify for uptiering. Applicable only when file_select_policy is kLastAccessed.' type: - integer - 'null' format: uint32 x-go-name: NumFileAccess sourceViewName: description: The source view name from which the data will be uptiered. type: - string - 'null' x-go-name: SourceViewName uptierAllFiles: description: 'If set, all files in the view will be uptiered regardless of file_select_policy, num_file_access, hot_file_window, file_size constraints.' type: - boolean - 'null' x-go-name: UptierAllFiles x-go-package: magneto/base/env_params.pb SourceFilters_SourceFilter: description: 'Plain text filter: { source_filter: "TestDatabase", is_regex: false}. Wildcard filter: { source_filter: "Test?Database*", is_regex: false}. Regex filter: { source_filter: "^Test.*Database$", is_regex: true}.' type: object title: 'Message to capture a source filter. Listed below the supported filter types with examples.' properties: isRegex: description: 'If true, this implies ''source_filter'' is a regex filter. If false, it will be treated as wildcard/plain text filter.' type: - boolean - 'null' x-go-name: IsRegex sourceFilter: description: This contains the filter string. type: - string - 'null' x-go-name: SourceFilter x-go-package: magneto/base/magneto.pb 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 ProtectionInfo: description: dataLocation defines data location related information. type: object title: Protection Information. properties: endTimeUsecs: description: Specifies the end time for object retention. type: - integer - 'null' format: int64 x-go-name: EndTimeUsecs location: description: Specifies the location of the object. type: - string - 'null' x-go-name: Location policyId: description: Specifies the id of the policy. type: - string - 'null' x-go-name: PolicyId protectionJobId: description: Specifies the id of the protection job. type: - integer - 'null' format: int64 x-go-name: ProtectionJobId protectionJobName: description: Specifies the protection job name which protects this object. type: - string - 'null' x-go-name: ProtectionJobName retentionPeriod: description: Specifies the retention period. type: - integer - 'null' format: int64 x-go-name: RetentionPeriod startTimeUsecs: description: Specifies the start time for object retention. type: - integer - 'null' format: int64 x-go-name: StartTimeUsecs storageDomain: description: Specifies the storage domain name. type: - string - 'null' x-go-name: StorageDomain totalSnapshots: description: Specifies the total number of snapshots. type: - integer - 'null' format: int64 x-go-name: TotalSnapshots 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 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 ViewIdMappingProto_FileLevelDataLockConfig: type: object title: File level data lock configuration. properties: autoLockDurationUsecs: description: 'Auto-lock automatically commit files to WORM state in the filesystem if they have not been modified for an administrator-specified period of time. When the auto-lock is enabled, this field must be set to idle time duration after which file would be automatically locked. Auto locking will be disabled when configured with default value of -1.' type: - integer - 'null' format: int64 x-go-name: AutoLockDurationUsecs defaultRetentionDurationUsecs: description: 'Default retention duration is used when an explicit retention timestamp is not set by user/application when locking a file. If the administrator does not want to enforce this, this field must not be set. If file requires being retained forever by default, this must be set to INT64_MAX. If minimum and maximum retention are enforced, then this must be always between these two durations.' type: - integer - 'null' format: int64 x-go-name: DefaultRetentionDurationUsecs holdTimestampUsecs: description: 'Specifies timestamp to protect locked files until a specific date. This would override retention periods and deny any mutable or remove operations on locked files until a specific date.' type: - integer - 'null' format: int64 x-go-name: HoldTimestampUsecs maxRetentionDurationUsecs: description: 'Specifies maximum retention duration of worm locked file. If the administrator does not want to enforce this, this must not be set. If default and max retention duration are enforced, max retention duration must be greater than or equal to default retention duration. If min and max retention duration are enforced, max retention duration must be greater than and equal to min retention duration.' type: - integer - 'null' format: int64 x-go-name: MaxRetentionDurationUsecs minRetentionDurationUsecs: description: 'Minimum and maximum retention duration allow the administrator to enforce retention duration that falls within a specified range. If the administrator does not want to enforce this, this must not be set. If the file requires being retained forever, this must be set to INT64_MAX. If default retention is enforced, this must be less than or equal to default retention. If max retention are enforced, default retention duration must be less than and equal to max retention duration.' type: - integer - 'null' format: int64 x-go-name: MinRetentionDurationUsecs mode: description: Explicit locking mode. type: - integer - 'null' format: int32 x-go-name: Mode protocol: description: Explicit locking protocol. type: - integer - 'null' format: int32 x-go-name: Protocol x-go-package: bridge/view_keeper/view_metadata.pb AWSFleetParams_NetworkParamsMapEntry: type: object properties: key: type: - string - 'null' x-go-name: Key value: $ref: '#/components/schemas/AWSFleetParams_NetworkParams' x-go-package: magneto/base/entities/aws.pb ViewAlias: description: Specifies the parameters of a view alias. type: object title: Alias. properties: aliasName: description: Alias name. type: - string - 'null' x-go-name: AliasName enableSmbEncryption: description: 'Specifies the SMB encryption for the View Alias. If set, it enables the SMB encryption for the View Alias. 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 enableSmbViewDiscovery: description: If set, it enables discovery of view alias for SMB. type: - boolean - 'null' x-go-name: EnableSmbViewDiscovery enforceSmbEncryption: description: 'Specifies the SMB encryption for all the sessions for the View Alias. If set, encryption is enforced for all the sessions for the View Alias. When enabled all future and existing unencrypted sessions are disallowed.' type: - boolean - 'null' x-go-name: EnforceSmbEncryption sharePermissions: description: Specifies a list of share level permissions. type: - array - 'null' items: $ref: '#/components/schemas/SmbPermission' x-go-name: SharePermissions subnetWhitelist: description: 'Specifies a list of Subnets with IP addresses that have permissions to access the View Alias. (Overrides the Subnets specified at the global Cohesity Cluster level and View level.)' type: - array - 'null' items: $ref: '#/components/schemas/Subnet' x-go-name: SubnetWhitelist viewName: description: View name. type: - string - 'null' x-go-name: ViewName viewPath: description: View path for the alias. type: - string - 'null' x-go-name: ViewPath x-go-package: cohesity/iris/server/data/public CloudDeployTarget: description: 'Message that specifies the details about CloudDeploy target where backup snapshots may be converted and stored.' type: object properties: deployVmsToCloudParams: description: 'Note that only the id field would be set for all the entities in DeployVMsToCloudParams. This is ok as we don''t replicate the policy to remote cluster currently. When we decide to replicate the policy to remote clusters, we need to populate the remaining fields.' title: 'Contains information needed to identify various resources when deploying VMs to Cloud.' $ref: '#/components/schemas/DeployVMsToCloudParams' targetEntity: description: 'Although we use EntityProto here, only the id field would be set in this proto. This is ok as we don''t replicate the policy to remote cluster currently. When we decide to replicate the policy to remote clusters, we need to populate the remaining fields.' title: Entity corresponding to the cloud deploy target. $ref: '#/components/schemas/EntityProto' type: description: The type of the CloudDeploy target. type: - integer - 'null' format: int32 x-go-name: Type x-go-package: magneto/base/policy.pb EntityIdentifier: description: Specifies a unique identifier for the entity. type: object title: Entity Identifier. properties: entityId: description: Specifies the unique identifier for the entity in the source Cluster. $ref: '#/components/schemas/Value' x-go-package: stats/base/stats.pb 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 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 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 BackupPolicyProto: description: 'If a backup does not get a chance to when it''s due (either due to the system being busy or a conflict with another instance of the same job), the backup will still be run when the conflicts go away. But, if there are multiple instances of the same job that are due to be run, only the latest instance would be run.' type: object title: DEPRECATED in 5.0! properties: continuousSchedule: description: Set if periodicity is kContinuous. $ref: '#/components/schemas/BackupPolicyProto_ContinuousSchedule' dailySchedule: description: Set if periodicity is kDaily. $ref: '#/components/schemas/BackupPolicyProto_DailySchedule' monthlySchedule: description: Set if periodicity is kMonthly. $ref: '#/components/schemas/BackupPolicyProto_MonthlySchedule' name: description: A backup schedule can have an optional name. type: - string - 'null' x-go-name: Name numDaysToKeep: description: 'Specifies how to determine the expiration time for snapshots created by a backup run. The snapshots will be marked as expiring (i.e., eligible to be garbage collected) in ''num_days_to_keep'' days from when the snapshots were created.' type: - integer - 'null' format: int64 x-go-name: NumDaysToKeep numRetries: description: The number of retries to perform (for retryable errors) before giving up. type: - integer - 'null' format: int32 x-go-name: NumRetries oneOffSchedule: description: Set if periodicity is kOneOff. $ref: '#/components/schemas/BackupPolicyProto_OneOffSchedule' periodicity: description: Determines how often the job should be run. type: - integer - 'null' format: int32 x-go-name: Periodicity retryDelayMins: description: The number of minutes to wait before retrying a failed job. type: - integer - 'null' format: int32 x-go-name: RetryDelayMins scheduleEnd: description: Determines when this schedule ends (if at all). $ref: '#/components/schemas/BackupPolicyProto_ScheduleEnd' startWindowIntervalMins: description: 'This field determines the amount of time (in minutes) after which a scheduled job will not be started. For example, if a job is scheduled to be run every Sunday at 5am, and this field is set to 30 minutes, but the job was unable to start by 5:30am on a Sunday due to other conflicts (say too many other jobs were already running), Magneto will not attempt to start the job until the next scheduled time (on the following Sunday). If this field is not set, the interval will be determined by the Magneto flag --magneto_master_default_start_window_interval_mins.' type: - integer - 'null' format: int32 x-go-name: StartWindowIntervalMins truncateLogs: description: 'Whether to truncate logs after a backup run. This is currently only relevant for full or incremental backups in a SQL environment.' type: - boolean - 'null' x-go-name: TruncateLogs x-go-package: magneto/base/magneto.pb Value: description: Specifies a data type and data field used to store data. type: object title: Value. properties: data: $ref: '#/components/schemas/Value_Data' type: description: 'Specifies the type of value. 0 specifies a data point of type Int64. 1 specifies a data point of type Double. 2 specifies a data point of type String. 3 specifies a data point of type Bytes.' type: - integer - 'null' format: int32 x-go-name: Type x-go-package: stats/base/stats_types.pb 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 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 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 MSExchangeParams: description: All the params specific to MS exchange application. type: object title: MS Exchange Parameters. properties: performLogTruncation: description: 'If this is set to true, then an attempt will be made to truncate exchange logs.' type: - boolean - 'null' x-go-name: PerformLogTruncation x-go-package: magneto/base/env_params.pb BackupJobPreOrPostScript: description: 'A message to encapsulate the pre and post scripts associated with a backup job. Pre script is executed before backup run of a job starts. Post script is executed after backup run of a job finishes. Currently, pre and post script is only supported for backup job of type ''kPuppeteer'' and agent-based backup jobs.' type: object properties: backupScript: description: 'Script specific to the incremental/regular backup. If the script is not specified, incremental backup run will fail. For agent-based backup jobs, only following script is considered. The script file will be looked in the agent installation directory. If the file is not present, then it will be logged in Pulse and backup job continues without throwing any error/warning.' $ref: '#/components/schemas/ScriptPathAndParams' fullBackupScript: description: 'Script specific to the full backup. If the script is not specified, full backup run will fail.' $ref: '#/components/schemas/ScriptPathAndParams' logBackupScript: description: 'Script specific to the log backup. If the script is not specified, log backup run will fail.' $ref: '#/components/schemas/ScriptPathAndParams' remoteHostParams: description: 'Connector params for the host on which script is executed. This field is mandatory for job of type kPuppeteer and optional for other job types.' $ref: '#/components/schemas/RemoteHostConnectorParams' x-go-package: magneto/base/magneto.pb ACLProto_Grant: type: object title: Message to define a grantee and its permission. properties: grantee: description: 'Identifier of a grantee. It can be either a registered user or one of Amazon S3 predefined group.' $ref: '#/components/schemas/GranteeProto' permissionVec: description: Vector of permission granted to this grantee. type: - array - 'null' items: type: integer format: int32 x-go-name: PermissionVec x-go-package: bridge/s3_portal/base/s3_metadata.pb 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 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 AgentDeploymentStatusResponse: description: Specifies the overview of the agent deployment status. type: object title: Agent Deployment Status Response. properties: compactVersion: description: Specifies the compact version of Cohesity agent. For example, 6.0.1. type: - string - 'null' x-go-name: CompactVersion healthStatus: description: 'Specifies the health status of the Cohesity agent. 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: HealthStatus hostIp: description: Specifies the IP of the host on which the agent is installed. type: - string - 'null' x-go-name: HostIp hostOsType: description: 'Specifies the host type on which the agent is installed. ''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: HostOsType lastUpgradeStatus: description: 'Specifies the status of the last upgrade attempt. 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: LastUpgradeStatus upgradability: description: 'Specifies the upgradability of the agent running on the 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 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 Cohesity software version of the agent. For example: 6.0.1-release-YYYYMMDD_' type: - string - 'null' x-go-name: Version 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 ClusterIdentifier: type: object title: ClusterIdentifier uniquely identifies a cluster. properties: clusterId: description: Specifies the cluster id of the cluster. type: - integer - 'null' format: int64 x-go-name: ClusterId clusterIncarnationId: description: Specifies the cluster incarnation id. type: - integer - 'null' format: int64 x-go-name: ClusterIncarnationId x-go-package: cohesity/iris/server/data/public CommonACLProto_Grantees: type: object properties: allUsers: description: This field indicates if all users are granted ACL permission. type: - boolean - 'null' x-go-name: AllUsers deniedReferrerVec: description: This field holds a list of referers who are denied ACL permission. type: - array - 'null' items: type: string x-go-name: DeniedReferrerVec grantedReferrerVec: description: This field holds a list of referers who are granted ACL permission. type: - array - 'null' items: type: string x-go-name: GrantedReferrerVec rlistings: description: 'This fields indicates if container GET and HEAD operations are permitted provided that read access is granted (using referer ACL) on objects.' type: - boolean - 'null' x-go-name: Rlistings x-go-package: bridge/s3_portal/base/s3_metadata.pb 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 AWSFleetParams: type: object title: Params for AWS fleets deployment. properties: fleetSubnetType: description: 'Fleet''s subnet type. This field should always be set when specifying fleet params.' type: - integer - 'null' format: int32 x-go-name: FleetSubnetType fleetTagVec: description: Optional list of tags to be associated with the fleets. type: - array - 'null' items: $ref: '#/components/schemas/AWSFleetParams_Tag' x-go-name: FleetTagVec networkParams: description: 'Network information for the fleet. This will be only set when fleet_subnet_type is kCustom.' $ref: '#/components/schemas/AWSFleetParams_NetworkParams' networkParamsMap: description: 'Map for a region to network params, as network params can be defined per region. Only set when kCustom fleet subnet type is being used.' type: - array - 'null' items: $ref: '#/components/schemas/AWSFleetParams_NetworkParamsMapEntry' x-go-name: NetworkParamsMap networkParamsVec: description: 'Network information for the fleet. This will be only set when fleet_subnet_type is kCustom.' type: - array - 'null' items: $ref: '#/components/schemas/AWSFleetParams_NetworkParams' x-go-name: NetworkParamsVec x-go-package: magneto/base/entities/aws.pb 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 LifecycleConfigProto: description: 'Protobuf that describes the lifecycle configuration that is used to manage the lifecycle of objects in a bucket.' type: object x-go-package: bridge/s3_portal/base/s3_metadata.pb AWSSnapshotManagerParams: type: object title: Proto to encapsulate additional params for AWS snapshot manager jobs. properties: amiCreationFrequency: description: 'The frequency of AMI creation. This should be set if the option to create AMI is set. A value of n creates an AMI from the snapshots after every n runs. eg. n = 2 implies every alternate backup run starting from the first will create an AMI.' type: - integer - 'null' format: int32 x-go-name: AmiCreationFrequency createAmiForRun: description: Whether we need to create an AMI for this run. type: - boolean - 'null' x-go-name: CreateAmiForRun shouldCreateAmi: description: Whether we need to create an AMI after taking snapshots of the instance. type: - boolean - 'null' x-go-name: ShouldCreateAmi x-go-package: magneto/base/env_params.pb 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 DataUsageStats: description: 'Specifies the data usage metric of the data stored on the Cohesity Cluster or Storage Domains (View Boxes).' type: object title: Data Usage Statistics. properties: cloudDataWrittenBytes: description: 'Specifies the total data written on cloud tiers, as computed by the Cohesity Cluster.' type: - integer - 'null' format: int64 x-go-name: CloudDataWrittenBytes cloudDataWrittenBytesTimestampUsec: description: Specifies Timestamp of CloudDataWrittenBytes. type: - integer - 'null' format: int64 x-go-name: CloudDataWrittenBytesTimestampUsec cloudTotalPhysicalUsageBytes: description: 'Specifies the total cloud capacity, as computed by the Cohesity Cluster, after the size of the data has been reduced by change-block tracking, compression and deduplication.' type: - integer - 'null' format: int64 x-go-name: CloudTotalPhysicalUsageBytes cloudTotalPhysicalUsageBytesTimestampUsec: description: Specifies Timestamp of CloudTotalPhysicalUsageBytes. type: - integer - 'null' format: int64 x-go-name: CloudTotalPhysicalUsageBytesTimestampUsec dataInBytes: description: 'Specifies the data read from the protected objects by the Cohesity Cluster before any data reduction using deduplication and compression.' type: - integer - 'null' format: int64 x-go-name: DataInBytes dataInBytesAfterDedup: description: 'Specifies the size of the data has been reduced by change-block tracking and deduplication but before compression or data is replicated to other nodes as per RF or Erasure Coding policy.' type: - integer - 'null' format: int64 x-go-name: DataInBytesAfterDedup dataInBytesAfterDedupTimestampUsec: description: Specifies Timestamp of DataInBytesAfterDedup. type: - integer - 'null' format: int64 x-go-name: DataInBytesAfterDedupTimestampUsec dataInBytesTimestampUsec: description: Specifies Timestamp of DataInBytes. type: - integer - 'null' format: int64 x-go-name: DataInBytesTimestampUsec dataProtectLogicalUsageBytes: description: Specifies the logical data used by Data Protect on Cohesity cluster. type: - integer - 'null' format: int64 x-go-name: DataProtectLogicalUsageBytes dataProtectLogicalUsageBytesTimestampUsec: description: Specifies Timestamp of DataProtectLogicalUsageBytes. type: - integer - 'null' format: int64 x-go-name: DataProtectLogicalUsageBytesTimestampUsec dataProtectPhysicalUsageBytes: description: Specifies the physical data used by Data Protect on Cohesity cluster. type: - integer - 'null' format: int64 x-go-name: DataProtectPhysicalUsageBytes dataProtectPhysicalUsageBytesTimestampUsec: description: Specifies Timestamp of DataProtectPhysicalUsageBytes. type: - integer - 'null' format: int64 x-go-name: DataProtectPhysicalUsageBytesTimestampUsec dataWrittenBytes: description: 'Specifies the data written after it has been reduced by deduplication and compression. This does not include resiliency impact.' type: - integer - 'null' format: int64 x-go-name: DataWrittenBytes dataWrittenBytesTimestampUsec: description: Specifies Timestamp of DataWrittenBytes. type: - integer - 'null' format: int64 x-go-name: DataWrittenBytesTimestampUsec fileServicesLogicalUsageBytes: description: Specifies the logical data used by File services on Cohesity cluster. type: - integer - 'null' format: int64 x-go-name: FileServicesLogicalUsageBytes fileServicesLogicalUsageBytesTimestampUsec: description: Specifies Timestamp of FileServicesLogicalUsageBytes. type: - integer - 'null' format: int64 x-go-name: FileServicesLogicalUsageBytesTimestampUsec fileServicesPhysicalUsageBytes: description: Specifies the physical data used by File services on Cohesity cluster. type: - integer - 'null' format: int64 x-go-name: FileServicesPhysicalUsageBytes fileServicesPhysicalUsageBytesTimestampUsec: description: Specifies Timestamp of FileServicesPhysicalUsageBytes. type: - integer - 'null' format: int64 x-go-name: FileServicesPhysicalUsageBytesTimestampUsec localDataWrittenBytes: description: 'Specifies the total data written on local tiers, as computed by the Cohesity Cluster, after the size of the data has been reduced by change-block tracking, deduplication and compression. This does not include resiliency impact.' type: - integer - 'null' format: int64 x-go-name: LocalDataWrittenBytes localDataWrittenBytesTimestampUsec: description: Specifies Timestamp of LocalDataWrittenBytes. type: - integer - 'null' format: int64 x-go-name: LocalDataWrittenBytesTimestampUsec localTierResiliencyImpactBytes: description: 'Specifies the size of the data has been replicated to other nodes as per RF or Erasure Coding policy.' type: - integer - 'null' format: int64 x-go-name: LocalTierResiliencyImpactBytes localTierResiliencyImpactBytesTimestampUsec: description: Specifies Timestamp of LocalTierResiliencyImpactBytes. type: - integer - 'null' format: int64 x-go-name: LocalTierResiliencyImpactBytesTimestampUsec localTotalPhysicalUsageBytes: description: 'Specifies the total local capacity, as computed by the Cohesity Cluster, after the size of the data has been reduced by change-block tracking, compression and deduplication.' type: - integer - 'null' format: int64 x-go-name: LocalTotalPhysicalUsageBytes localTotalPhysicalUsageBytesTimestampUsec: description: Specifies Timestamp of LocalTotalPhysicalUsageBytes. type: - integer - 'null' format: int64 x-go-name: LocalTotalPhysicalUsageBytesTimestampUsec outdatedLogicalUsageBytesTimestampUsec: description: Specifies Timestamp of OutdatedLogicalUsageBytes. type: - integer - 'null' format: int64 x-go-name: OutdatedLogicalUsageBytesTimestampUsec storageConsumedBytes: description: 'Specifies the total capacity, as computed by the Cohesity Cluster, after the size of the data has been reduced by change-block tracking, compression and deduplication. This includes resiliency impact.' type: - integer - 'null' format: int64 x-go-name: StorageConsumedBytes storageConsumedBytesTimestampUsec: description: Specifies Timestamp of StorageConsumedBytes. type: - integer - 'null' format: int64 x-go-name: StorageConsumedBytesTimestampUsec totalLogicalUsageBytes: description: 'Provides the combined data residing on protected objects. The size of data before reduction by deduplication and compression.' type: - integer - 'null' format: int64 x-go-name: TotalLogicalUsageBytes totalLogicalUsageBytesTimestampUsec: description: Specifies Timestamp of TotalLogicalUsageBytes. type: - integer - 'null' format: int64 x-go-name: TotalLogicalUsageBytesTimestampUsec uniquePhysicalDataBytes: description: Specifies the unique physical data usage in bytes. type: - integer - 'null' format: int64 x-go-name: UniquePhysicalDataBytes x-go-package: cohesity/iris/server/data/public DeployVMsToAWSParams: description: 'Contains AWS specific information needed to identify various resources when converting and deploying a VM to AWS.' type: object properties: instanceType: description: Type of VM when cloning the VM in AWS as an instance. $ref: '#/components/schemas/EntityProto' keyPairName: description: 'Optional key-pair (public-private) name that can be used to login to an VM instance. In such case, user should have already created a key-pair and have a copy of the private key.' $ref: '#/components/schemas/EntityProto' networkSecurityGroups: description: 'Names of the network security groups within the above VPC. At least one entry should be present.' type: - array - 'null' items: $ref: '#/components/schemas/EntityProto' x-go-name: NetworkSecurityGroups proxyVmSubnet: description: 'Name of the subnet within the above VPC which will be associated with the proxy vm.' $ref: '#/components/schemas/EntityProto' proxyVmVpc: description: Virtual Private Cloud (VPC) in which the proxy vm will be deployed. $ref: '#/components/schemas/EntityProto' rdsParams: description: 'Proto containing the additional parameters required for restoring RDS DB. This field will only be populated for RDS restores.' $ref: '#/components/schemas/DeployDBInstancesToRDSParams' region: description: Name of the AWS region in which to deploy the VM. $ref: '#/components/schemas/EntityProto' subnet: description: Name of the optional subnet within the above VPC. $ref: '#/components/schemas/EntityProto' vpc: description: The Virtual Private Cloud (VPC) to choose for the instance. $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/cloud_deploy.pb SqlBackupJobParams: description: Message to capture additional backup job params specific to SQL. type: object title: SQL Backup Job Parameters. properties: aagBackupPreferenceType: description: 'Preference type for backing up databases that are part of an AAG. Only applicable if ''use_aag_preferences_from_sql_server'' is set to false.' type: - integer - 'null' format: int32 x-go-name: AagBackupPreferenceType backupDatabaseVolumesOnly: description: 'If set to true, only the volumes associated with databases should be backed up. The user cannot select additional volumes at host level for backup. If set to false, all the volumes on the host machine will be backed up. In this case, the user can further select the exact set of volumes using host level params. Note that the volumes associated with selected databases will always be included in the backup.' type: - boolean - 'null' x-go-name: BackupDatabaseVolumesOnly backupSystemDbs: description: Set to true if system databases should be backed up. type: - boolean - 'null' x-go-name: BackupSystemDbs continueAfterError: description: Whether backup should continue after encountering a page checksum error. type: - boolean - 'null' x-go-name: ContinueAfterError enableChecksum: description: Whether backup checksums are enabled. type: - boolean - 'null' x-go-name: EnableChecksum enableIncrementalBackupAfterRestart: description: 'If this is set to true, then incremental backup will be performed after the server restarts, otherwise a full-backup will be done.' type: - boolean - 'null' x-go-name: EnableIncrementalBackupAfterRestart fullBackupType: description: The type of SQL full backup to be used for this job. type: - integer - 'null' format: int32 x-go-name: FullBackupType isCopyOnlyFull: description: Whether full backups should be copy-only. type: - boolean - 'null' x-go-name: IsCopyOnlyFull isCopyOnlyLog: description: Whether log backups should be copy-only. type: - boolean - 'null' x-go-name: IsCopyOnlyLog numDbsPerBatch: description: 'The number of databases to be backed up per batch. This is only applicable for file based sql backup. If this is not specified, we use the value specified in magneto_vss_sql_app_file_batch_size gflag.' type: - integer - 'null' format: int32 x-go-name: NumDbsPerBatch numStreams: description: 'The number of streams to be used in native sql backup command. This is only applicable for native sql backup. If this is not specified, we use the value specified in magneto_sql_num_streams_for_each_db_backup gflag.' type: - integer - 'null' format: int32 x-go-name: NumStreams useAagPreferencesFromSqlServer: description: 'Set to true if we should use AAG preferences specified at the SQL server host.' type: - boolean - 'null' x-go-name: UseAagPreferencesFromSqlServer userDbPreferenceType: description: Preference type for backing up user databases on the host. type: - integer - 'null' format: int32 x-go-name: UserDbPreferenceType withClause: description: '''with_clause'' contains ''with clause'' to be used in native sql backup command. This is only applicable for native sql backup. Here user can specify multiple backup options. Example: "WITH BUFFERCOUNT = 575, MAXTRANSFERSIZE = 2097152". If this is not specified, we use the value specified in magneto_sql_native_backup_with_clause gflag.' type: - string - 'null' x-go-name: WithClause x-go-package: magneto/base/env_params.pb HBaseConnectParams: description: 'Specifies an Object containing information about a registered HBase source.' type: object title: HBase Connect Params. properties: hdfsEntityId: description: The entity id of the HDFS source for this HBase type: - integer - 'null' format: int64 x-go-name: HdfsEntityId kerberosPrincipal: description: Specifies the kerberos principal. type: - string - 'null' x-go-name: KerberosPrincipal rootDataDirectory: description: Specifies the HBase data root directory. type: - string - 'null' x-go-name: RootDataDirectory zookeeperQuorum: description: Specifies the HBase zookeeper quorum. type: - array - 'null' items: type: string x-go-name: ZookeeperQuorum x-go-package: cohesity/iris/server/data/public 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 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 EntityProto: description: Specifies the attributes and the latest statistics about an entity. type: object title: Entity. properties: attributeVec: description: 'Array of Attributes. List of attributes of an entity.' type: - array - 'null' items: $ref: '#/components/schemas/KeyValuePair' x-go-name: AttributeVec entityId: description: Specifies a globally unique identifier of an entity. $ref: '#/components/schemas/EntityIdentifier' latestMetricVec: description: 'Array of Metric Statistics. List of the latest statistics for all metrics defined in the schema that this entity belongs to. If statistics for a metric is not available, then that data point is not returned.' type: - array - 'null' items: $ref: '#/components/schemas/MetricValue' x-go-name: LatestMetricVec x-go-package: stats/base/stats.pb TrendingData: description: 'Specifies protection runs information per object, aggregated over a period of time.' type: object properties: cancelled: description: Specifies number of cancelled runs. type: - integer - 'null' format: int64 x-go-name: Cancelled failed: description: Specifies number of failed runs. type: - integer - 'null' format: int64 x-go-name: Failed running: description: Specifies number of in-progress runs. type: - integer - 'null' format: int64 x-go-name: Running successful: description: Specifies number of successful runs. type: - integer - 'null' format: int64 x-go-name: Successful total: description: Specifies total number of runs. type: - integer - 'null' format: int64 x-go-name: Total trendName: description: Specifies trend name. This is start of the day/week/month. type: - string - 'null' x-go-name: TrendName trendStartTimeUsecs: description: Specifies start of the day/week/month in micro seconds type: - integer - 'null' format: int64 x-go-name: TrendStartTimeUsecs 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 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 UserIdMapping: description: Specifies how the Unix and Windows users are mapped in an Active Directory. type: object title: User ID Mapping. properties: centrifyZoneMapping: description: 'Specifies a centrify zone when mapping type is set to ''kCentrify''. It defines a centrify zone from which the user id mapping info would be derived.' $ref: '#/components/schemas/CentrifyZone' customAttributesMapping: description: 'Specifies the custom attributes when mapping type is set to ''kCustomAttributes''. It defines the attribute names to derive the mapping for a user of an Active Directory domain.' $ref: '#/components/schemas/CustomUnixIdAttributes' fixedMapping: description: 'Specifies the fields when mapping type is set to ''kFixed''. It maps all Active Directory users of this domain to a fixed uid, and gid.' $ref: '#/components/schemas/FixedUnixIdMapping' type: description: 'Specifies the mapping type used. ''kRid'' indicates the kRid mapping type. ''kRfc2307'' indicates the kRfc2307 mapping type. ''kSfu30'' indicates the kSfu30 mapping type. ''kCentrify'' indicates the mapping type to refer to a centrify zone. ''kFixed'' indicates the mapping from all Active Directory users to a fixed Unix uid, and gid. ''kCustomAttributes'' indicates the mapping to derive from custom attributes defined in an AD domain. ''kLdapProvider'' indicates the Active Directory to LDAP provider mapping.' type: - string - 'null' enum: - kRid - kRfc2307 - kSfu30 - kCentrify - kFixed - kCustomAttributes - kLdapProvider x-go-name: Type x-go-package: cohesity/iris/server/data/public FileStubbingParams: description: 'File Stubbing Parameters Message to capture the additional stubbing params for a file-based environment.' type: object properties: coldFileWindow: description: 'Identifies the cold files in the NAS source. Files that haven''t been accessed/modified in the last cold_file_window msecs or are older than cold_window_msecs are migrated.' type: - integer - 'null' format: int64 x-go-name: ColdFileWindow deleteOrphanData: description: Delete migrated data if no symlink at source is pointing to it. type: - boolean - 'null' x-go-name: DeleteOrphanData fileSelectPolicy: description: File migrate policy based on file access/modify time and age. type: - integer - 'null' format: int32 x-go-name: FileSelectPolicy fileSize: description: 'Gives the size criteria to be used for selecting the files to be migrated. The cold files that are equal and greater than file_size or smaller than file_size are migrated.' type: - integer - 'null' format: int64 x-go-name: FileSize fileSizePolicy: description: File size policy for selecting files to migrate. type: - integer - 'null' format: int32 x-go-name: FileSizePolicy filteringPolicy: description: 'The filtering policy to decide which objects within a source should be stubbed. If this is not specified, then all the objects within the source will be migrated based on the migration policy. We use the filtering_policy in NasBackupParams. So this field is deprecated.' $ref: '#/components/schemas/FilteringPolicyProto' migrateWithoutStub: description: Migrate data without stub. type: - boolean - 'null' x-go-name: MigrateWithoutStub nfsMountPath: description: 'Mount path where the Cohesity target view must be mounted on all NFS clients for accessing the migrated data.' type: - string - 'null' x-go-name: NfsMountPath targetViewName: description: The target view name to which the data will be migrated. type: - string - 'null' x-go-name: TargetViewName x-go-package: magneto/base/env_params.pb 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 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 CentrifyZone: description: 'Specifies the properties associated to a Centrify zone of an Active Directory domain.' type: object title: Centrify Zone. properties: centrifySchema: description: 'Specifies the schema of this Centrify zone. The below list of schemas and their values are taken from the document Centrify Server Suite 2016 Windows API Programmer''s Guide https://docs.centrify.com/en/css/suite2016/centrify-win-progguide.pdf ''kCentrifyDynamicSchema_1_0'' specifies dynamic schema, version 1.0. ''kCentrifyDynamicSchema_2_0'' specifies dynamic schema, version 2.0. ''kCentrifyDynamicSchema_3_0'' specifies dynamic schema, version 3.0. ''kCentrifyDynamicSchema_5_0'' specifies dynamic schema, version 5.0. ''kCentrifySfu_3_0'' specifies sfu schema, version 3.0. ''kCentrifySfu_3_0_V5'' specifies sfu schema, 3.0.5. ''kCentrifySfu_4_0'' specifies sfu schema, version 4.0. ''kCentrifyCdcRfc2307'' specifies cdcrfc2307 schema. ''kCentrifyCdcRfc2307_2'' specifies cdcrfc2307, version 2. ''kCentrifyCdcRfc2307_3'' specifies cdcrfc2307, version 3.' type: - string - 'null' enum: - kCentrifyDynamicSchema_1_0 - kCentrifyDynamicSchema_2_0 - kCentrifySfu_3_0 - kCentrifySfu_4_0 - kCentrifyCdcRfc2307 - kCentrifyDynamicSchema_3_0 - kCentrifyCdcRfc2307_2 - kCentrifyDynamicSchema_5_0 - kCentrifyCdcRfc2307_3 - kCentrifySfu_3_0_V5 x-go-name: CentrifySchema description: description: Specifies a description of the Centrify zone. type: - string - 'null' x-go-name: Description distinguishedName: description: Specifies the distinguished name of the Centrify zone. type: - string - 'null' x-go-name: DistinguishedName 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 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 MongoDBAdditionalParams: description: 'Contains additional parameters required for taking backup from this Mongo cluster.' type: object properties: secondaryNodeTag: description: 'The tag associated with the secondary nodes from which backups should be performed.' type: - array - 'null' items: type: string x-go-name: SecondaryNodeTag useSecondaryForBackup: description: Set to true if this cluster uses secondary nodes for backup. type: - boolean - 'null' x-go-name: UseSecondaryForBackup x-go-package: magneto/base/nosql.pb DeployVMsToCloudParams: description: 'Contains Cloud specific information needed to identify various resources when deploying a VM to Cloud.' type: object properties: deployFleetParams: $ref: '#/components/schemas/DeployFleetParams' deployVmsToAwsParams: $ref: '#/components/schemas/DeployVMsToAWSParams' deployVmsToAzureParams: $ref: '#/components/schemas/DeployVMsToAzureParams' deployVmsToGcpParams: $ref: '#/components/schemas/DeployVMsToGCPParams' replicateSnapshotsToAwsParams: $ref: '#/components/schemas/ReplicateSnapshotsToAWSParams' replicateSnapshotsToAzureParams: $ref: '#/components/schemas/ReplicateSnapshotsToAzureParams' x-go-package: magneto/base/cloud_deploy.pb 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 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 RetentionPolicyProto: description: Message that specifies the retention policy for backup snapshots. type: object title: Retention Policy Proto. properties: numDaysToKeep: description: The number of days to keep the snapshots for a backup run. type: - integer - 'null' format: int64 x-go-name: NumDaysToKeep numSecsToKeep: description: The number of seconds to keep the snapshots for a backup run. type: - integer - 'null' format: int32 x-go-name: NumSecsToKeep wormRetention: description: 'If the WORM lock is enabled on this policy, details of WORM policy. Absence of this field indicates WORM is not enabled on this policy. Also, presence of this field doesn''t necessarily imply WORM protection. This is because the field could be present but the retention could have expired. If the policy has WORM enabled, We do not propagate it to attached backup jobs and further down the hierarchy here. Instead, any update on the backup run performs WORM checks based on the currently attached policy. Backup runs, when finished, inherit the WORM property from the corresponding attached policy at the completion time.' $ref: '#/components/schemas/WormRetentionProto' x-go-package: magneto/base/policy.pb 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 DataTransferFromVaultSummary: description: 'Specifies summary statistics about the transfer of data from a Vault to this Cohesity Cluster.' type: object title: Data Transfer From Vault Summary. properties: dataTransferPerTask: description: 'Array of Data Transferred Per Task. Specifies the transfer of data from this Vault to this Cohesity Cluster for each clone or recover task.' type: - array - 'null' items: $ref: '#/components/schemas/DataTransferFromVaultPerTask' x-go-name: DataTransferPerTask numLogicalBytesTransferred: description: 'Specifies the total number of logical bytes that have been transferred from this Vault (External Target) to this Cohesity Cluster. The logical size is when the data is fully hydrated or expanded.' type: - integer - 'null' format: int64 x-go-name: NumLogicalBytesTransferred numPhysicalBytesTransferred: description: 'Specifies the total number of physical bytes that have been transferred from this Vault (External Target) to the Cohesity Cluster.' type: - integer - 'null' format: int64 x-go-name: NumPhysicalBytesTransferred numTasks: description: 'Specifies the number of recover or clone tasks that have transferred data from this Vault (External Target) to this Cohesity Cluster.' type: - integer - 'null' format: int64 x-go-name: NumTasks physicalDataTransferredBytesDuringTimeRange: description: 'Array of Physical Data Transferred Per Day. Specifies the physical data transferred from this Vault to the Cohesity Cluster during the time period specified using the startTimeMsecs and endTimeMsecs parameters. For each day in the time period, an array element is returned, for example if 7 days are specified, 7 array elements are returned.' type: - array - 'null' items: type: integer format: int64 x-go-name: PhysicalDataTransferredBytesDuringTimeRange vaultName: description: Specifies the name of the Vault (External Target). type: - string - 'null' x-go-name: VaultName 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 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 NoSqlBackupJobParams: type: object title: Contains backup params at the job level applicable for nosql environment. properties: bandwidthBytesPerSecond: description: Net bandwidth bytes per second. type: - integer - 'null' format: int64 x-go-name: BandwidthBytesPerSecond cassandraBackupJobParams: description: Params specific to cassandra backup job. $ref: '#/components/schemas/CassandraBackupJobParams' compactionJobIntervalSecs: description: 'Frequency at which compaction jobs should run in seconds. Will be only applicable for Cassandra, Mongo and Couchbase environment.' type: - integer - 'null' format: int64 x-go-name: CompactionJobIntervalSecs concurrency: description: Max number of mappers. type: - integer - 'null' format: int32 x-go-name: Concurrency couchbaseBackupJobParams: description: Params specific to couchbase backup job. $ref: '#/components/schemas/CouchbaseBackupJobParams' gcJobIntervalSecs: description: Frequency at which garbage collection jobs should run in seconds. type: - integer - 'null' format: int64 x-go-name: GcJobIntervalSecs gcRetentionPeriodDays: description: Retention period for logs of this job in days. type: - integer - 'null' format: int32 x-go-name: GcRetentionPeriodDays hbaseBackupJobParams: description: Params specific to hbase backup job. $ref: '#/components/schemas/HBaseBackupJobParams' hdfsBackupJobParams: description: Params specific to hdfs backup job. $ref: '#/components/schemas/HdfsBackupJobParams' hiveBackupJobParams: description: Params specific to hive backup job. $ref: '#/components/schemas/HiveBackupJobParams' lastCompactionRunTimeUsecs: description: The last time (in usecs) when the compaction ran for this jobs. type: - integer - 'null' format: int64 x-go-name: LastCompactionRunTimeUsecs lastGcRunTimeUsecs: description: The last time (in usecs) when the gc ran for this jobs. type: - integer - 'null' format: int64 x-go-name: LastGcRunTimeUsecs mongodbBackupJobParams: description: Params specific to mongodb backup job. $ref: '#/components/schemas/MongoDBBackupJobParams' x-go-package: magneto/base/nosql.pb SourceFilters: description: 'For SQL, this filters will be applicable only for auto protect sources and can be used at the host, instance level.' type: object title: Message to capture filters to include/exclude entities from the backup. properties: excludeSourceFilterVec: description: 'This contains the list of exclude filters to be applied on the entities in the backup source.' type: - array - 'null' items: $ref: '#/components/schemas/SourceFilters_SourceFilter' x-go-name: ExcludeSourceFilterVec x-go-package: magneto/base/magneto.pb 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 User: description: Specifies details about a user. type: object title: User Details. properties: additionalGroupNames: description: 'Array of Additional Groups. Specifies the names of additional groups this User may belong to.' type: - array - 'null' items: type: string x-go-name: AdditionalGroupNames authenticationType: description: 'Specifies the authentication type of the user. ''kAuthLocal'' implies authenticated user is a local user. ''kAuthAd'' implies authenticated user is an Active Directory user. ''kAuthSalesforce'' implies authenticated user is a Salesforce user. ''kAuthGoogle'' implies authenticated user is a Google user. ''kAuthSso'' implies authenticated user is an SSO user.' type: - string - 'null' enum: - kAuthLocal - kAuthAd - kAuthSalesforce - kAuthGoogle - kAuthSso x-go-name: AuthenticationType clusterIdentifiers: description: 'Specifies the list of clusters this user has access to. If this is not specified, access will be granted to all clusters.' type: - array - 'null' items: $ref: '#/components/schemas/ClusterIdentifier' x-go-name: ClusterIdentifiers createdTimeMsecs: description: 'Specifies the epoch time in milliseconds when the user account was created on the Cohesity Cluster.' type: - integer - 'null' format: int64 x-go-name: CreatedTimeMsecs description: description: Specifies a description about the user. type: - string - 'null' x-go-name: Description domain: description: 'Specifies the fully qualified domain name (FQDN) of an Active Directory or LOCAL for the default LOCAL domain on the Cohesity Cluster. A user is uniquely identified by combination of the username and the domain.' type: - string - 'null' x-go-name: Domain effectiveTimeMsecs: description: 'Specifies the epoch time in milliseconds when the user becomes effective. Until that time, the user cannot log in.' type: - integer - 'null' format: int64 x-go-name: EffectiveTimeMsecs emailAddress: description: Specifies the email address of the user. type: - string - 'null' x-go-name: Email expiredTimeMsecs: description: 'Specifies the epoch time in milliseconds when the user becomes expired. After that, the user cannot log in.' type: - integer - 'null' format: int64 x-go-name: ExpiredTimeMsecs forcePasswordChange: description: Specifies whether to force user to change password. type: - boolean - 'null' x-go-name: ForcePasswordChange googleAccount: description: 'Specifies additional information pertaining to Google account. This field is set only for Helios BaaS users who has account on Google.' $ref: '#/components/schemas/GoogleAccountInfo' groupRoles: description: 'Specifies the Cohesity roles to associate with the user'' group. These roles can only be edited from group.' type: - array - 'null' items: type: string x-go-name: GroupRoles readOnly: true idpUserInfo: description: 'Specifies additional information pertaining to an IdP user. This field is set only for IdP users who has logged in via IdP.' $ref: '#/components/schemas/IdpUserInfo' lastUpdatedTimeMsecs: description: 'Specifies the epoch time in milliseconds when the user account was last modified on the Cohesity Cluster.' type: - integer - 'null' format: int64 x-go-name: LastUpdatedTimeMsecs orgMembership: description: 'OrgMembership contains the list of all available tenantIds for this user to switch to. Only when creating the session user, this field is populated on the fly. We discover the tenantIds from various groups assigned to the users.' type: - array - 'null' items: $ref: '#/components/schemas/TenantConfig' x-go-name: OrgMembership password: description: Specifies the password of this user. type: - string - 'null' x-go-name: Password preferences: description: Specifies preferences of the user. $ref: '#/components/schemas/Preferences' primaryGroupName: description: Specifies the name of the primary group of this User. type: - string - 'null' x-go-name: PrimaryGroupName privilegeIds: description: 'Array of Privileges. Specifies the Cohesity privileges from the roles. This will be populated based on the union of all privileges in roles. Type for unique privilege Id values. All below enum values specify a value for all uniquely defined privileges in Cohesity.' type: - array - 'null' items: type: string enum: - kPrincipalView - kPrincipalModify - kAppLaunch - kAppsManagement - kOrganizationView - kOrganizationModify - kOrganizationImpersonate - kCloneView - kCloneModify - kClusterView - kClusterModify - kClusterCreate - kClusterSupport - kClusterUpgrade - kClusterRemoteView - kClusterRemoteModify - kClusterExternalTargetView - kClusterExternalTargetModify - kClusterAudit - kAlertView - kAlertModify - kVlanView - kVlanModify - kHybridExtenderView - kHybridExtenderDownload - kAdLdapView - kAdLdapModify - kSchedulerView - kSchedulerModify - kProtectionView - kProtectionModify - kProtectionJobOperate - kProtectionSourceModify - kProtectionPolicyView - kProtectionPolicyModify - kRestoreView - kRestoreModify - kRestoreDownload - kRemoteRestore - kStorageView - kStorageModify - kStorageDomainView - kStorageDomainModify - kAnalyticsView - kAnalyticsModify - kReportsView - kMcmModify - kDataSecurity - kSmbBackup - kSmbRestore - kSmbTakeOwnership - kSmbAuditing - kMcmUnregister - kMcmUpgrade - kMcmModifySuperAdmin - kMcmViewSuperAdmin - kMcmModifyCohesityAdmin - kMcmViewCohesityAdmin - kObjectSearch - kFileDatalockExpiryTimeDecrease x-go-name: PrivilegeIds restricted: description: 'Whether the user is a restricted user. A restricted user can only view the objects he has permissions to.' type: - boolean - 'null' x-go-name: Restricted roles: description: 'Array of Roles. Specifies the Cohesity roles to associate with the user such as such as ''Admin'', ''Ops'' or ''View''. The Cohesity roles determine privileges on the Cohesity Cluster for this user.' type: - array - 'null' items: type: string x-go-name: Roles s3AccessKeyId: description: Specifies the S3 Account Access Key ID. type: - string - 'null' x-go-name: S3AccessKeyId s3AccountId: description: Specifies the S3 Account Canonical User ID. type: - string - 'null' x-go-name: S3AccountId s3SecretKey: description: Specifies the S3 Account Secret Key. type: - string - 'null' x-go-name: S3SecretKey salesforceAccount: description: 'Specifies additional information pertaining to Salesforce account. This field is set only for Helios users who has account on Salesforce.' $ref: '#/components/schemas/SalesforceAccountInfo' sid: description: 'Specifies the unique Security ID (SID) of the user. This field is mandatory in modifying user.' type: - string - 'null' x-go-name: Sid tenantId: description: Specifies the effective Tenant ID of the user. type: - string - 'null' x-go-name: TenantId username: description: Specifies the login name of the user. type: - string - 'null' x-go-name: Username x-go-package: cohesity/iris/server/data/public 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 UserInformation: description: 'A message to encapsulate information about the user who made the request. Request should be filtered by these fields if specified so that only the objects that the user is permissioned for are returned. If both sid_vec & tenant_id are specified then an intersection of respective results should be returned.' type: object title: User Information. properties: includeSubtenantObjects: description: 'Whether objects owned by subtenants should be returned. This would require a prefix search with the passed tenant_id. All tenants are considered sub-tenants of the admin. For GET requests, if tenant id is empty(admin user is querying) and if this flag is false, we will only return untagged objects. If it is true, we will return everything.' type: - boolean - 'null' x-go-name: IncludeSubtenantObjects pulseAttributeVec: description: 'Specifies the KeyValuePair that client (eg. Iris) wants to persist along with the corresponding (soon-to-be-created) Pulse task for the current action. Eg. pulse_attribute_vec can drive user notifications by associating a Pulse Task with user SID and later Pulse can be searched by client specified Sid to get all finished tasks for the logged in user.' type: - array - 'null' items: $ref: '#/components/schemas/KeyValuePair' x-go-name: PulseAttributeVec sidVec: description: 'If specified, only the objects associated with these SIDs should be returned.' type: - array - 'null' items: $ref: '#/components/schemas/ClusterConfigProto_SID' x-go-name: SidVec tenantIdVec: description: 'If specified, only the objects associated with this tenant should be returned. A given tenant ID is always a prefix of the ids of its subtenants. Eg. if tenant_id of cluster admin is empty string then it will be a prefix match for all the tenants on the cluster.' type: - array - 'null' items: type: string x-go-name: TenantIdVec x-go-package: magneto/base/permissions.pb 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 S3BucketConfigProto_TagMapEntry: type: object properties: key: type: - string - 'null' x-go-name: Key value: type: - string - 'null' x-go-name: Value x-go-package: bridge/s3_portal/base/s3_metadata.pb 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 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 GoogleAccountInfo: description: Google Account Information of a Helios BaaS user. type: object title: Google Account Information. properties: accountId: description: Specifies the Account Id assigned by Google. type: - string - 'null' x-go-name: AccountId userId: description: Specifies the User Id assigned by Google. type: - string - 'null' x-go-name: UserId x-go-package: cohesity/iris/server/data/public 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 Time: description: 'A message to encapusulate time of a day. Users of this proto will have to store the timezone information separately. For example, when this proto is part of a backup job, timezone of the backup job is applied to get the absolute time.' type: object properties: hour: description: The hour when backup should be performed (0 - 23). type: - integer - 'null' format: int32 x-go-name: Hour minute: description: The minute when backup should be performed (0 - 59). type: - integer - 'null' format: int32 x-go-name: Minute x-go-package: magneto/base/policy.pb ArchivalExternalTarget: description: Specifies settings about the Archival External Target (such as Tape or AWS). type: object title: Archival Target. properties: vaultId: description: Specifies the id of Archival Vault assigned by the Cohesity Cluster. type: - integer - 'null' format: int64 x-go-name: VaultId vaultName: description: Name of the Archival Vault. type: - string - 'null' x-go-name: VaultName vaultType: description: 'Specifies the type of the Archival External Target such as ''kCloud'', ''kTape'' or ''kNas''. ''kCloud'' indicates the archival location as Cloud. ''kTape'' indicates the archival location as Tape. ''kNas'' indicates the archival location as Network Attached Storage (Nas).' type: - string - 'null' enum: - kCloud - kTape - kNas x-go-name: VaultType x-go-package: cohesity/iris/server/data/public 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 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 DataTransferFromVaultsSummaryResponse: description: 'Provides summary statistics about the transfer of data from Vaults (External Targets) to this Cohesity Cluster.' type: object title: Data Transfer from Vaults Summary Response. properties: dataTransferSummary: description: 'Array of Summary Data Transfer Statistics. Specifies summary statistics about the transfer of data from Vaults to the Cohesity Cluster.' type: - array - 'null' items: $ref: '#/components/schemas/DataTransferFromVaultSummary' x-go-name: DataTransferSummary x-go-package: cohesity/iris/server/data/public OracleSbtHostParams: type: object title: Message to capture Oracle SBT host info. properties: sbtLibraryPath: description: The path of sbt library, This is set only when backup type is kSbt. type: - string - 'null' x-go-name: SbtLibraryPath viewFsPath: description: Cohesity view path. type: - string - 'null' x-go-name: ViewFsPath vipVec: description: Vector of Cohesity primary VIPs. type: - array - 'null' items: type: string x-go-name: VipVec vlanInfoVec: description: Vlan information for Cohesity cluster. type: - array - 'null' items: $ref: '#/components/schemas/OracleVlanInfo' x-go-name: VlanInfoVec x-go-package: magneto/base/env_params.pb MetricValue: description: Specifies one data point of a metric. type: object title: Metric Value. properties: metricName: description: Specifies the metric name. type: - string - 'null' x-go-name: MetricName timestampMsecs: description: 'Specifies the creation time of a data point as a Unix epoch Timestamp (in milliseconds).' type: - integer - 'null' format: int64 x-go-name: TimestampMsecs value: description: Specifies the value of the data point. $ref: '#/components/schemas/Value' x-go-package: stats/base/stats.pb 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 DataTransferToVaultSummary: description: 'Specifies statistics about the transfer of data from this Cohesity Cluster to a Vault.' type: object title: Data Transfer to Vault Summary. properties: dataTransferPerProtectionJob: description: 'Array of Data Transfer Statistics Per Protection Jobs. Specifies the data transfer summary statistics for each Protection Job that is transferring data from this Cohesity Cluster to this Vault (External Target).' type: - array - 'null' items: $ref: '#/components/schemas/DataTransferToVaultPerProtectionJob' x-go-name: DataTransferPerProtectionJob logicalDataTransferredBytesDuringTimeRange: description: 'Array of Logical Data Transferred Per Day. Specifies the logical data transferred from this Cohesity Cluster to this Vault during the time period specified using the startTimeMsecs and endTimeMsecs parameters. For each day in the time period, an array element is returned, for example if 7 days are specified, 7 array elements are returned. The logical size is when the data is fully hydrated or expanded.' type: - array - 'null' items: type: integer format: int64 x-go-name: LogicalDataTransferredBytesDuringTimeRange numLogicalBytesTransferred: description: 'Specifies the total number of logical bytes that are transferred from this Cohesity Cluster to this Vault. The logical size is when the data is fully hydrated or expanded.' type: - integer - 'null' format: int64 x-go-name: NumLogicalBytesTransferred numPhysicalBytesTransferred: description: 'Specifies the total number of physical bytes that are transferred from this Cohesity Cluster to this Vault.' type: - integer - 'null' format: int64 x-go-name: NumPhysicalBytesTransferred numProtectionJobs: description: 'Specifies the number of Protection Jobs that transfer data to this Vault.' type: - integer - 'null' format: int64 x-go-name: NumProtectionJobs physicalDataTransferredBytesDuringTimeRange: description: 'Array of Physical Data Transferred Per Day. Specifies the physical data transferred from this Cohesity Cluster to this Vault during the time period specified using the startTimeMsecs and endTimeMsecs parameters. For each day in the time period, an array element is returned, for example if 7 days are specified, 7 array elements are returned.' type: - array - 'null' items: type: integer format: int64 x-go-name: PhysicalDataTransferredBytesDuringTimeRange storageConsumedBytes: description: 'Specifies the storage consumed on the Vault as of last day in the specified time range.' type: - integer - 'null' format: int64 x-go-name: StorageConsumedBytes vaultId: description: The vault Id associated with the vault. type: - integer - 'null' format: int64 x-go-name: VaultId vaultName: description: Specifies the name of the Vault (External Target). type: - string - 'null' x-go-name: VaultName vaultType: description: 'Specifies the type of Vault. ''kNearline'' indicates a Google Nearline Vault. ''kGlacier'' indicates an AWS Glacier Vault. ''kS3'' indicates an AWS S3 Vault. ''kAzureStandard'' indicates a Microsoft Azure Standard Vault. ''kS3Compatible'' indicates an S3 Compatible Vault. (See the online help for supported types.) ''kQStarTape'' indicates a QStar Tape Vault. ''kGoogleStandard'' indicates a Google Standard Vault. ''kGoogleDRA'' indicates a Google DRA Vault. ''kAmazonS3StandardIA'' indicates an Amazon S3 Standard-IA Vault. ''kAWSGovCloud'' indicates an AWS Gov Cloud Vault. ''kNAS'' indicates a NAS Vault. ''kColdline'' indicates a Google Coldline Vault. ''kAzureGovCloud'' indicates a Microsoft Azure Gov Cloud Vault. ''kAzureArchive'' indicates an Azure Archive Vault. ''kAzure'' indicates an Azure Vault. ''kGoogle'' indicates a Google Vault. ''kAmazon'' indicates an Amazon Vault. ''kOracle'' indicates an Oracle Vault. ''kOracleTierStandard'' indicates an Oracle Tier Standard Vault. ''kOracleTierArchive'' indicates an Oracle Tier Archive Vault. ''kAmazonC2S'' indicates an Amazon Commercial Cloud Services Vault.' type: - string - 'null' enum: - kNearline - kGlacier - kS3 - kAzureStandard - kS3Compatible - kQStarTape - kGoogleStandard - kGoogleDRA - kAmazonS3StandardIA - kAWSGovCloud - kNAS - kColdline - kAzureGovCloud - kAzureArchive - kAzure - kGoogle - kAmazon - kOracle - kOracleTierStandard - kOracleTierArchive - kAmazonC2S x-go-name: VaultType x-go-package: cohesity/iris/server/data/public SnapshotTarget: description: 'Message that specifies details about a target (such as a replication or archival target) where a backup snapshot may be copied to.' type: object properties: archivalTarget: description: The archival target for the backup snapshot. $ref: '#/components/schemas/ArchivalTarget' cloudDeployTarget: description: 'The cloud deploy target for the backup snapshot. This will be populated for both kCloudDeploy and kCloudReplication tasks.' $ref: '#/components/schemas/CloudDeployTarget' replicationTarget: description: The remote replication target for the backup snapshot. $ref: '#/components/schemas/ReplicationTarget' type: description: The type of snapshot target this proto represents. type: - integer - 'null' format: int32 x-go-name: Type x-go-package: magneto/base/policy.pb TenantInfo: description: Specifies struct with basic tenant details. type: object title: Tenant Information. properties: name: description: Specifies name of the tenant. type: - string - 'null' x-go-name: Name tenantId: description: Specifies the unique id of the tenant. type: - string - 'null' x-go-name: TenantId x-go-package: cohesity/iris/server/data/public ReplicationTarget: description: 'Message that specifies the details about a remote cluster where backup snapshots may be replicated to.' type: object properties: clusterId: description: The id of the remote cluster. type: - integer - 'null' format: int64 x-go-name: ClusterId clusterName: description: The name of the remote cluster. type: - string - 'null' x-go-name: ClusterName x-go-package: magneto/base/policy.pb StubbingPolicyProto: description: 'Stubbing jobs do not use protection policies. Instead, schedule and retention policy will be embedded in the BackupJobProto.' type: object title: Message to capture scheduling and retention policies for stubbing jobs. properties: retentionPolicy: description: Retention policy for snapshots taken after each stubbing job run. $ref: '#/components/schemas/RetentionPolicyProto' schedulingPolicy: description: Schedule for running stubbing job. $ref: '#/components/schemas/SchedulingPolicyProto' x-go-package: magneto/base/magneto.pb 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 CustomUnixIdAttributes: description: 'Specifies the custom attributes when mapping type is set to ''kCustomAttributes''. It defines the attribute names to derive the mapping for a user of an Active Directory domain.' type: object title: Custom Unix ID Attributes. properties: gidAttrName: description: 'Specifies the custom field name in Active Directory user properties to get the GID.' type: - string - 'null' x-go-name: GidAttrName uidAttrName: description: 'Specifies the custom field name in Active Directory user properties to get the UID.' type: - string - 'null' x-go-name: UidAttrName 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 LdapProviderResponse: description: LDAP provider response struct. type: object title: LDAP Provider Response. properties: adDomainName: description: 'Specifies the domain name of an Active Directory which is mapped to this LDAP provider' type: - string - 'null' x-go-name: AdDomainName authType: description: 'Specifies the authentication type used while connecting to LDAP servers. Authentication level. ''kAnonymous'' indicates LDAP authentication type ''Anonymous'' ''kSimple'' indicates LDAP authentication type ''Simple''' type: - string - 'null' enum: - kAnonymous - kSimple x-go-name: AuthType baseDistinguishedName: description: 'Specifies the base distinguished name used as the base for LDAP search requests.' type: - string - 'null' x-go-name: BaseDistinguishedName domainName: description: 'Specifies the name of the domain name to be used for querying LDAP servers from DNS. If PreferredLdapServerList is set, then DomainName field is ignored.' type: - string - 'null' x-go-name: DomainName id: description: Specifies the ID of the LDAP provider. type: - integer - 'null' format: int64 x-go-name: Id name: description: Specifies the name of the LDAP provider. type: - string - 'null' x-go-name: Name port: description: Specifies LDAP server port. type: - integer - 'null' format: int32 x-go-name: Port preferredLdapServerList: description: 'Specifies the preferred LDAP servers. Server names should be either in fully qualified domain name (FQDN) format or IP addresses.' type: - array - 'null' items: type: string x-go-name: PreferredLdapServerList tenantId: description: Specifies the unique id of the tenant. type: - string - 'null' x-go-name: TenantId useSsl: description: Specifies whether to use SSL for LDAP connections. type: - boolean - 'null' x-go-name: UseSsl userDistinguishedName: description: 'Specifies the user distinguished name that is used for LDAP authentication. It should be provided if the AuthType is set to either kSimple or kSasl.' type: - string - 'null' x-go-name: UserDistinguishedName userPassword: description: Specifies the user password that is used for LDAP authentication. type: - string - 'null' x-go-name: UserPassword 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 AzureManagedDiskParams: description: 'Contains managed disk parameters needed to deploy to Azure using managed disk.' type: object properties: dataDisksSkuType: description: SKU type for data disks. type: - integer - 'null' format: int32 x-go-name: DataDisksSkuType osDiskSkuType: description: SKU type for OS disk. type: - integer - 'null' format: int32 x-go-name: OsDiskSkuType x-go-package: magneto/base/cloud_deploy.pb PhysicalFileBackupParams_GlobalIncludeExclude: description: 'Descibes job level includes and excludes. Right now, only supports excludes but includes will be added in future.' type: object properties: excludeVec: description: 'Describes exclude vec at job level used in combination with to exclude_paths to exclude files.' type: - array - 'null' items: type: string x-go-name: ExcludeVec x-go-package: magneto/base/env_params.pb OracleVlanInfo: type: object title: Message to capture Cohesity cluster vlan info for Oracle workflow. properties: gateway: description: Gateway for this VLAN. type: - string - 'null' x-go-name: Gateway id: description: ID of this VLAN. type: - integer - 'null' format: int32 x-go-name: Id ipVec: description: List of IPs in this VLAN. type: - array - 'null' items: type: string x-go-name: IpVec subnetIp: description: Subnet IP for this VLAN. type: - string - 'null' x-go-name: SubnetIp x-go-package: magneto/base/env_params.pb BackupJobProto_DRToCloudParams: description: 'A Proto needed in case objects backed up by this job need to DR to cloud. "Fail over" signifies the mechanism to move the workload to cloud.' type: object title: DR to Cloud Parameters. properties: needToFailOver: description: 'Whether the objects in this job will be failed over to cloud. In case of VMs, we need to fetch information about the logical volumes present on the VM. Magneto might fail backup of a VM in case volume information can not be fetched (maybe because the agent is not installed or if the VM is turned off etc.). The VM will be backed up using the physical agent when it is running in the cloud. We might choose to backup the VM in the cloud using native API at a later point. This flag makes sense when configuring a job to backup on-prem VMs.' type: - boolean - 'null' x-go-name: NeedToFailOver x-go-package: magneto/base/magneto.pb 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 SchedulingPolicyProto_RPOSchedule: type: object properties: rpoIntervalMins: description: 'If this field is set, then at any point, a recovery point should be available not older than the given interval mins.' type: - integer - 'null' format: int64 x-go-name: RpoIntervalMins x-go-package: magneto/base/policy.pb SourceAppParams: description: 'This message contains params specific to application running on the source such as a VM or a physical host.' type: object properties: isVssCopyOnly: description: If the backup is a VSS full backup with the copy-only option specified. type: - boolean - 'null' x-go-name: IsVssCopyOnly msExchangeParams: description: MS Exchange params. $ref: '#/components/schemas/MSExchangeParams' x-go-package: magneto/base/env_params.pb Credentials: description: Specifies credentials to access a target source. type: object title: Credentials. properties: password: description: Specifies password of the username to access the target source. type: - string - 'null' x-go-name: Password username: description: Specifies username to access the target source. type: - string - 'null' x-go-name: Username x-go-package: cohesity/iris/server/data/public 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 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 SnapshotCopyTask: description: 'Specifies information about copy tasks such as replication and archival tasks.' type: object title: Snapshot Copy Task. properties: copyStatus: description: Specifies the status of the copy task. type: - string - 'null' x-go-name: CopyStatus expiryTimeUsecs: description: Specifies when the Snapshot expires on the target. type: - integer - 'null' format: int64 x-go-name: ExpiryTimeUsecs message: description: 'Specifies warning or error information when the copy task is not successful.' type: - string - 'null' x-go-name: Message snapshotTarget: description: Specifies the target location where the Snapshot was copied to. $ref: '#/components/schemas/SnapshotTargetSettings' x-go-package: cohesity/iris/server/data/public O365BackupEnvParams: description: 'Message to capture any additional backup params for Office365 environment. This encapsulates both Outlook & OneDrive backup parameters.' type: object title: Office365 Backup Environment Parameters. properties: filteringPolicy: description: 'This field has been deprecated. Use ''filtering_policy'' specified within ''outlook_backup_params'' for Outlook exclusions filter and ''onedrive_backup_params'' for OneDrive exclusions filter respectively.' $ref: '#/components/schemas/FilteringPolicyProto' onedriveBackupParams: description: 'OneDrive specific backup parameters. Refer ''OneDriveBackupEnvParams'' for details.' $ref: '#/components/schemas/OneDriveBackupEnvParams' outlookBackupParams: description: 'Outlook specific backup parameters. Refer ''OutlookBackupEnvParams'' for details.' $ref: '#/components/schemas/OutlookBackupEnvParams' publicFoldersBackupParams: description: 'PublicFolders specific backup parameters. Refer ''PublicFoldersEnvParams'' for details.' $ref: '#/components/schemas/PublicFoldersBackupEnvParams' siteBackupParams: description: 'SharePoint specific backup parameters. Refer ''SharepPointSiteBackupEnvParams'' for details.' $ref: '#/components/schemas/SharepPointSiteBackupEnvParams' x-go-package: magneto/base/env_params.pb PhysicalBackupSourceParams: description: Message to capture additional backup params for a Physical type source. type: object title: Physical Backup Source Parameters. properties: enableSystemBackup: description: 'Allows Magneto to drive a "system" backup using a 3rd-party tool installed on the Agent host.' type: - boolean - 'null' x-go-name: EnableSystemBackup fileBackupParams: description: 'If the backup job type is kPhysicalFiles, this field should be set to specify the files to be backed up from the volumes on this source.' $ref: '#/components/schemas/PhysicalFileBackupParams' snapshotParams: description: This captures params to use for taking the snapshot. $ref: '#/components/schemas/PhysicalSnapshotParams' sourceAppParams: description: 'This message will capture params for applications that are running as part of the server.' $ref: '#/components/schemas/SourceAppParams' volumeGuidVec: description: 'If this list is non-empty, then only volumes in this will be protected, otherwise all volumes belonging to the host will be protected.' type: - array - 'null' items: type: string x-go-name: VolumeGuidVec x-go-package: magneto/base/env_params.pb 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 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 SchedulingPolicyProto_MonthlySchedule: type: object properties: count: description: 'Count of the day on which to perform the backup (look above for a more detailed description).' type: - integer - 'null' format: int32 x-go-name: Count day: description: The day of the month the backup is to be performed. type: - integer - 'null' format: int32 x-go-name: Day x-go-package: magneto/base/policy.pb S3ViewBackupProperties: description: // ----------------------------------------------------------------------------- type: object properties: accessKey: description: 'Access key for the buckets which will be created for the source initiated jobs. This needs to be passed to Netapp for it to for doing all s3 communications.' type: - string - 'null' x-go-name: AccessKey s3Config: description: 'For source initiated backup the target is s3 view. This captures the configuration needed to create the s3 view.' $ref: '#/components/schemas/S3BucketConfigProto' secretKey: description: 'Secret key for the buckets will be created for the source initiated jobs. This secret key needed to be sent to Netapp for writing data to our S3 views.' type: - string - 'null' x-go-name: SecretKey snapshotPrefixName: description: 'The snapshot prefix which is needed at the time of incremental for backups. This is only needed for case of DP volume.' type: - string - 'null' x-go-name: SnapshotPrefixName viewId: description: The id of the S3 view. type: - integer - 'null' format: int64 x-go-name: ViewId x-go-package: magneto/base/env_params.pb JobPolicyProto: description: A message that specifies the policies to use for a job. type: object title: DEPRECATED in 5.0! properties: backupPolicy: description: 'Specifies the scheduling and retention policy to use when backing up sources.' $ref: '#/components/schemas/BackupPolicyProto' snapshotTargetPolicyVec: description: 'Specifies additional policies that can be used to copy snapshots created by a backup run to different targets (such as a remote replica, tape etc). Each policy also specifies the retention policy that should be applied to the copied snapshots at the respective target.' type: - array - 'null' items: $ref: '#/components/schemas/SnapshotTargetPolicyProto' x-go-name: SnapshotTargetPolicyVec x-go-package: magneto/base/magneto.pb OracleSourceParams: description: Message to capture additional backup/restore params for a Oracle source. type: object title: Oracle Source Parameters. properties: additionalOracleDbParamsVec: description: 'A vector of unique Oracle databases. Each vector entry represents the backup/restore parameters for one unique Oracle database. Uniqueness is determined by the database unique name.' type: - array - 'null' items: $ref: '#/components/schemas/AdditionalOracleDBParams' x-go-name: AdditionalOracleDbParamsVec persistMountpoints: description: 'This parameter indicates whether or not to persist mountpoints. Default is set to true, which was the behavior before this option.' type: - boolean - 'null' x-go-name: PersistMountpoints x-go-package: magneto/base/env_params.pb ClusterConfigProto_SID: description: 'Represents the security identifier that uniquely defines a security principal. SIDs are associated with users and groups. Reference: https://msdn.microsoft.com/en-us/library/aa379597.aspx' type: object properties: identifierAuthority: description: 'The authority under which the SID was created. This is always 6 bytes long.' type: - array - 'null' items: type: integer format: uint8 x-go-name: IdentifierAuthority revisionLevel: description: The revision level of the SID. type: - integer - 'null' format: int32 x-go-name: RevisionLevel subAuthority: description: 'List of ids relative to the identifier_authority that uniquely identify a principal. The last entry in this list is the RID, which uniquely identifies the principal within a domain.' type: - array - 'null' items: type: integer format: uint32 x-go-name: SubAuthority x-go-package: configs/cluster_config.pb Domain: type: object title: Keystone domain proto. properties: description: type: - string - 'null' x-go-name: Description enabled: type: - boolean - 'null' x-go-name: Enabled id: type: - string - 'null' x-go-name: Id links: description: Links to the domain resource. $ref: '#/components/schemas/Links' name: type: - string - 'null' x-go-name: Name x-go-package: bridge/s3_portal/keystone/keystone2.pb 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 GranularityBucket: description: 'Message that specifies the frequency granularity at which to copy the snapshots from a backup job''s runs.' type: object title: Granularity Bucket. properties: granularity: description: 'The base time period granularity that determines the frequency at which backup run snapshots will be copied. NOTE: The granularity (in combination with the ''multiplier'' field below) that is specified should be such that the frequency of copying snapshots is lower than the frequency of actually creating the snapshots (i.e., lower than the frequency of the backup job runs).' type: - integer - 'null' format: int32 x-go-name: Granularity multiplier: description: 'A factor to multiply the granularity by. For example, if this is 2 and the granularity is kHour, then snapshots from the first eligible run from every 2 hour period will be copied.' type: - integer - 'null' format: int32 x-go-name: Multiplier x-go-package: magneto/base/policy.pb CouchbaseBackupJobParams: description: 'Contains any additional couchbase environment specific backup params at the job level.' type: object x-go-package: magneto/base/nosql.pb CommonACLProto: description: 'Protobuf that describes the Common access control list (ACL) permissions for a swift container. TODO (avinash_aita): Verify the ''.rlistings'' write ACL behavior. If necessary, remove persisting ''write_rlistings'' field and fail such requests.' type: object properties: readGrantees: description: Read permissions granted to grantees. $ref: '#/components/schemas/CommonACLProto_Grantees' writeRlistings: description: Write permissions granted to grantees. type: - boolean - 'null' x-go-name: WriteRlistings x-go-package: bridge/s3_portal/base/s3_metadata.pb 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 TenantDeletionInfo: description: 'TenantDeletionInfo captures the individual deletion state of a category of objects marked tagged with a tenant_id (which has been marked for deletion).' type: object properties: category: description: Specifies the category of objects whose deletion state is being captured. type: - integer - 'null' format: int32 x-go-name: Category finishedAtTimeMsecs: description: Specifies the time when the process finished. type: - integer - 'null' format: int64 x-go-name: FinishedAtTimeMsecs processedAtNode: description: 'Specifies the node ip where the process ran. Typically this would be Iris Master.' type: - string - 'null' x-go-name: ProcessedAtNode retryCount: description: Specifies the number of times this task has been retried. type: - integer - 'null' format: int64 x-go-name: RetryCount startedAtTimeMsecs: description: Specifies the time when the process started. type: - integer - 'null' format: int64 x-go-name: StartedAtTimeMsecs state: description: Specifies the deletion completion state of the object category. type: - integer - 'null' format: int32 x-go-name: State x-go-package: cohesity/iris/server/data/public ViewStats: description: Provides statistics about the View. type: object title: View Stats. properties: dataUsageStats: description: Specifies the data usage metric of the data stored in this View. title: Data Usage Statistics. $ref: '#/components/schemas/DataUsageStats' id: description: Specifies the id of the View. type: - integer - 'null' format: int64 x-go-name: Id x-go-package: cohesity/iris/server/data/public SchedulingPolicyProto: type: object title: Message that specifies the scheduling policy for a backup job. properties: continuousSchedule: description: Set if periodicity is kContinuous. $ref: '#/components/schemas/SchedulingPolicyProto_ContinuousSchedule' dailySchedule: description: Set if periodicity is kDaily. $ref: '#/components/schemas/SchedulingPolicyProto_DailySchedule' monthlySchedule: description: Set if periodicity is kMonthly. $ref: '#/components/schemas/SchedulingPolicyProto_MonthlySchedule' periodicity: description: Determines how often the job should be run. type: - integer - 'null' format: int32 x-go-name: Periodicity rpoSchedule: description: Set if periodicity is kContinuousRPO. $ref: '#/components/schemas/SchedulingPolicyProto_RPOSchedule' x-go-package: magneto/base/policy.pb SnapshotManagerParams: type: object title: Proto to encapsulate additional params for snapshot manager jobs. properties: awsSnapshotManagerParams: $ref: '#/components/schemas/AWSSnapshotManagerParams' x-go-package: magneto/base/env_params.pb 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 KeystoneACLProto_Grantees: type: object properties: allUsers: description: This field indicates if all users are granted ACL permission. type: - boolean - 'null' x-go-name: AllUsers projectIdVec: description: 'This field holds a list of Keystone project ids whose users are granted ACL permission.' type: - array - 'null' items: type: string x-go-name: ProjectIdVec projectUsersMap: type: - array - 'null' items: $ref: '#/components/schemas/KeystoneACLProto_Grantees_ProjectUsersMapEntry' x-go-name: ProjectUsersMap roleNameVec: description: 'This field holds a list of Keystone roles for which any Keystone user with one (or more) of the roles on the project containing the swift container holding this KeystoneACLProto is granted ACL permission.' type: - array - 'null' items: type: string x-go-name: RoleNameVec userIdVec: description: 'This field holds a list of keystone user ids who are granted ACL permission.' type: - array - 'null' items: type: string x-go-name: UserIdVec x-go-package: bridge/s3_portal/base/s3_metadata.pb 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 ScriptPathAndParams: description: 'A message to encapsulate pre or post script associated with a backup job policy.' type: object properties: continueOnError: description: 'Applicable only for pre backup scripts. If this flag is set to true, then backup job will start even if the pre backup script fails.' type: - boolean - 'null' x-go-name: ContinueOnError isActive: description: 'Indicates if the script is active. If ''is_active'' is set to false, this script will not be executed even if it is part of the backup job.' type: - boolean - 'null' x-go-name: IsActive scriptParams: description: 'Custom parameters that users want to pass to the script. For example, if user wants to pass following params: 1. foo=bar 2. v=10. User can construct the param string as "far=bar v=10".' type: - string - 'null' x-go-name: ScriptParams scriptPath: description: 'For backup jobs of type ''kPuppeteer'', ''script_path'' is full path of location of the script within the host. For Pre/Post scripts of agent-based backup jobs, ''script_path'' is just name of the script, not full path.' type: - string - 'null' x-go-name: ScriptPath timeoutSecs: description: 'Timeout of the script. The script will be killed if it exceeds this value. ''-1'' indicates that the timeout is not set for the script.' type: - integer - 'null' format: int32 x-go-name: TimeoutSecs x-go-package: magneto/base/magneto.pb 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 IdpUserInfo: description: 'Specifies an IdP User''s information logged in using an IdP. This information is not stored on the Cluster.' type: object title: IdP User Information. properties: groups: description: 'Specifies the Idp groups that the user is part of. As the user may not be registered on the cluster, we may have to capture the idp group membership. This way, if a group is created on the cluster later, users will instantly have access to tenantIds from that group as well.' type: - array - 'null' items: type: string x-go-name: Groups idpId: description: Specifies the unique Id assigned by the Cluster for the IdP. type: - integer - 'null' format: int64 x-go-name: IdpId issuerId: description: Specifies the unique identifier assigned by the vendor for this Cluster. type: - string - 'null' x-go-name: IssuerId userId: description: Specifies the unique identifier assigned by the vendor for the user. type: - string - 'null' x-go-name: UserId vendor: description: Specifies the vendor providing the IdP service. type: - string - 'null' x-go-name: Vendor x-go-package: cohesity/iris/server/data/public 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 OracleBackupJobParams: description: Message to capture any additional backup params specific to Oracle. type: object title: Oracle Backup Enviroment Parameters. properties: persistMountpoints: description: 'Indicates whether the mountpoints created while backing up Oracle DBs should be persisted. If this is set to ''false'' all Oracle views mounted to the hosts will be unmounted at the end. Note: This parameter is for the entire Job. For overriding persistence of mountpoints for a subset of Oracle hosts within the job, refer OracleSourceParams.' type: - boolean - 'null' x-go-name: PersistMountpoints vlanParams: description: 'Indicates the vlan preference that is selected by the user for doing backup.' $ref: '#/components/schemas/VlanParams' x-go-package: magneto/base/env_params.pb OwnerInfo: type: object title: Information about a resource (i.e., bucket or object) owner. properties: userId: description: Unique identifier of the owner. type: - string - 'null' x-go-name: UserId x-go-package: bridge/s3_portal/base/s3_metadata.pb ProtectionSourcesJobsSummaryReportResponseWrapper: type: object title: Protection Sources Jobs Summary Report Response Wrapper. properties: protectionSourcesJobsSummary: description: 'Specifies the list of Snapshot summary statistics that match the filter criteria.' type: - array - 'null' items: $ref: '#/components/schemas/ProtectionSourcesSummaryStats' x-go-name: ProtectionSourcesSummary x-go-package: cohesity/iris/server/data/public SwiftParams: description: Specifies the parameters of Swift configuration. type: object title: Swift Parameters. properties: keystoneId: description: Specifies the associated Keystone configuration id. type: - integer - 'null' format: int64 x-go-name: KeystoneId operatorRoles: description: Specifies a list of operator roles. type: - array - 'null' items: type: string x-go-name: OperatorRoles x-go-package: cohesity/iris/server/data/public AWSFleetParams_NetworkParams: type: object title: Network params for a VM. properties: region: description: Region for the VM. type: - string - 'null' x-go-name: Region subnet: description: Subnet for the VM. type: - string - 'null' x-go-name: Subnet vpc: description: VPC for the VM. type: - string - 'null' x-go-name: Vpc x-go-package: magneto/base/entities/aws.pb HiveBackupJobParams: description: 'Contains any additional hive environment specific backup params at the job level.' type: object properties: hdfsConnectParams: description: Additional hdfs connection params required for Hive Backup. $ref: '#/components/schemas/HdfsConnectParams' x-go-package: magneto/base/nosql.pb 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 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 BackupPolicyProto_MonthlySchedule: type: object properties: count: description: 'Count of the day on which to perform the backup (look above for a more detailed description).' type: - integer - 'null' format: int32 x-go-name: Count day: description: The day of the month the backup is to be performed. type: - integer - 'null' format: int32 x-go-name: Day time: description: Time when the monthly backup should be performed. $ref: '#/components/schemas/Time' x-go-package: magneto/base/magneto.pb OracleDBChannelInfo_HostInfo: description: 'The name of this proto message is out-dated. This proto should generally be used to represent parameters needed for each Oracle ''cluster'' node. ''cluster'' here is a loose term used to include more than Oracle RAC cluster, e.g. ''active-passive'' cluster is also considered here as ''cluster'' and its ''cluster node will also be represented by the following proto.' type: object properties: host: description: '''agent_id'' of the host from which we are allowed to take the backup/restore.' type: - string - 'null' x-go-name: Host numChannels: description: 'Number of channels we need to create for this host. Default value for num_channels will be calculated as minimum of number of nodes in cohesity cluster, 2 * number of cpu on Oracle host.' type: - integer - 'null' format: int32 x-go-name: NumChannels portnum: description: port number where database is listening. type: - integer - 'null' format: int64 x-go-name: Portnum sbtHostParams: description: 'The necessury parameters for SBT. This is set only when backup type is kSbt.' $ref: '#/components/schemas/OracleSbtHostParams' x-go-package: magneto/base/env_params.pb View: description: 'Specifies settings for defining a storage location (called a View) with NFS and SMB mount paths in a Storage Domain (View Box) on the Cohesity Cluster.' 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 aliases: description: 'Aliases created for the view. A view alias allows a directory path inside a view to be mounted using the alias name.' type: - array - 'null' items: $ref: '#/components/schemas/ViewAlias' x-go-name: Aliases allSmbMountPaths: description: 'Array of SMB Paths. Specifies the possible paths that can be used to mount this View as a SMB share. If Active Directory has multiple account names; each machine account has its own path.' type: - array - 'null' items: type: string x-go-name: AllSmbMountPaths antivirusScanConfig: description: Specifies the antivirus scan config settings for this View. $ref: '#/components/schemas/AntivirusScanConfig' basicMountPath: description: 'Specifies the NFS mount path of the View (without the hostname information). This path is used to support NFS mounting of the paths specified in the nfsExportPathList on Windows systems.' type: - string - 'null' x-go-name: BasicMountPath caseInsensitiveNamesEnabled: description: 'Specifies whether to support case insensitive file/folder names. This parameter can only be set during create and cannot be changed.' type: - boolean - 'null' x-go-name: CaseInsensitiveNamesEnabled createTimeMsecs: description: Specifies the time that the View was created in milliseconds. type: - integer - 'null' format: int64 x-go-name: CreateTimeMsecs dataLockExpiryUsecs: description: 'DataLock (Write Once Read Many) lock expiry epoch time in microseconds. 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' isTargetForMigratedData: description: Specifies if a view contains migrated data. type: - boolean - 'null' x-go-name: IsTargetForMigratedData 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' logicalUsageBytes: description: LogicalUsageBytes is the logical usage in bytes for the view. type: - integer - 'null' format: int64 x-go-name: LogicalUsageBytes name: description: Specifies the name of the View. type: - string - 'null' x-go-name: Name 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' nfsMountPath: description: Specifies the path for mounting this View as an NFS share. type: - string - 'null' x-go-name: NfsMountPath 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' s3AccessPath: description: Specifies the path to access this View as an S3 share. type: - string - 'null' x-go-name: S3AccessPath s3KeyMappingConfig: description: 'Specifies the S3 key mapping config of the view. This parameter can only be set during create and cannot be changed. Configuration of S3 key mapping. Specifies the type of S3 key mapping config.' type: - string - 'null' enum: - kRandom - kShort - kLong - kHierarchical x-go-name: S3KeyMappingConfig 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 smbMountPath: description: Specifies the main path for mounting this View as an SMB share. type: - string - 'null' x-go-name: SmbMountPath smbPermissionsInfo: description: Specifies the SMB permissions for the View. $ref: '#/components/schemas/SmbPermissionsInfo' stats: description: 'Specifies statistics about the View. readOnly: true' $ref: '#/components/schemas/ViewStats' 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 swiftUserDomain: description: Specifies the Keystone user domain. type: - string - 'null' x-go-name: SwiftUserDomain swiftUsername: description: Specifies the Keystone username. type: - string - 'null' x-go-name: SwiftUsername tenantId: description: Optional tenant id who has access to this View. type: - string - 'null' x-go-name: TenantId viewBoxId: description: Specifies the id of the Storage Domain (View Box) where the View is stored. type: - integer - 'null' format: int64 x-go-name: ViewBoxId viewBoxName: description: Specifies the name of the Storage Domain (View Box) where the View is stored. type: - string - 'null' x-go-name: ViewBoxName viewId: description: Specifies an id of the View assigned by the Cohesity Cluster. type: - integer - 'null' format: int64 x-go-name: ViewId 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 viewProtection: description: Specifies information about the Protection Jobs protecting this View. $ref: '#/components/schemas/ViewProtection' x-go-package: cohesity/iris/server/data/public MongoDBBackupJobParams: description: 'Contains any additional mongodb environment specific backup params at the job level.' type: object properties: mongodbAdditionalInfo: description: Additional parameters required for Mongo backup $ref: '#/components/schemas/MongoDBAdditionalParams' x-go-package: magneto/base/nosql.pb 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 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 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 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 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 ObjectInformation: type: object properties: accessibleUsers: description: Species the list of user who have access to this object. type: - array - 'null' items: type: string x-go-name: AccessibleUsers auditLogs: description: Specifies the audit log information. type: - array - 'null' items: $ref: '#/components/schemas/ClusterAuditLog' x-go-name: AuditLogs copyTaskInfo: description: Specifies the copy task information. type: - array - 'null' items: $ref: '#/components/schemas/GdprCopyTask' x-go-name: CopyTaskInfo isProtected: description: Specifies the protection status of the object. type: - boolean - 'null' x-go-name: IsProtected location: description: Specifies the location of the parent source. type: - string - 'null' x-go-name: Location protectionInfo: description: Specifies the data locations for the protected objects. type: - array - 'null' items: $ref: '#/components/schemas/ProtectionInfo' x-go-name: ProtectionInfo rootNodeId: description: Specifies the id of the root node. type: - integer - 'null' format: int64 x-go-name: RootNodeId sourceId: description: Specifies the id of the Protection Source. type: - integer - 'null' format: int64 x-go-name: SourceId sourceName: description: Specifies the name of the object. type: - string - 'null' x-go-name: SourceName 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 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 BackupPolicyProto_ScheduleEnd: type: object title: Only one of the following fields should be set. properties: endAfterNumBackups: description: 'If specified, the backup job will no longer be run after it has been run these many times.' type: - integer - 'null' format: int64 x-go-name: EndAfterNumBackups endTimeUsecs: description: If specified, the backup job will no longer be run after this time. type: - integer - 'null' format: int64 x-go-name: EndTimeUsecs x-go-package: magneto/base/magneto.pb 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 CassandraPortsInfo: description: Specifies an Object containing information on various Cassandra ports. type: object title: Cassandra Ports Info. properties: jmxPort: description: Specifies the Cassandra JMX port. type: - integer - 'null' format: uint32 x-go-name: JmxPort nativeTransportPort: description: Specifies the port for the CQL native transport. type: - integer - 'null' format: uint32 x-go-name: NativeTransportPort rpcPort: description: 'Specifies the Remote Procedure Call (RPC) port for general mechanism for client-server applications.' type: - integer - 'null' format: uint32 x-go-name: RpcPort sslStoragePort: description: Specifies the SSL port for encrypted communication. type: - integer - 'null' format: uint32 x-go-name: SslStoragePort storagePort: description: Specifies the TCP port for data. Internally used by Cassandra bulk loader. type: - integer - 'null' format: uint32 x-go-name: StoragePort x-go-package: cohesity/iris/server/data/public DeployDBInstancesToRDSParams: description: 'Contains RDS specfic options that can be supplied while restoring the RDS DB instance.' type: object properties: autoMinorVersionUpgrade: description: Whether to enable auto minor version upgrade in the restored DB. type: - boolean - 'null' x-go-name: AutoMinorVersionUpgrade availabilityZone: description: Entity representing the availability zone to use while restoring the DB. $ref: '#/components/schemas/EntityProto' copyTagsToSnapshots: description: Whether to enable copying of tags to snapshots of the DB. type: - boolean - 'null' x-go-name: CopyTagsToSnapshots dbInstanceId: description: 'The DB instance identifier to use for the restored DB. This field is required.' type: - string - 'null' x-go-name: DbInstanceId dbOptionGroup: description: Entity representing the RDS option group to use while restoring the DB. $ref: '#/components/schemas/EntityProto' dbParameterGroup: description: Entity representing the RDS parameter group to use while restoring the DB. $ref: '#/components/schemas/EntityProto' dbPort: description: Port to use for the DB in the restored RDS instance. type: - integer - 'null' format: int32 x-go-name: DbPort iamDbAuthentication: description: Whether to enable IAM authentication for the DB. type: - boolean - 'null' x-go-name: IamDbAuthentication multiAzDeployment: description: Whether this is a multi-az deployment or not. type: - boolean - 'null' x-go-name: MultiAzDeployment pointInTimeParams: description: If this is set, we will restore DB to the specified point in time. $ref: '#/components/schemas/DeployDBInstancesToRDSParams_PointInTimeRestoreParams' publicAccessibility: description: Whether this DB will be publicly accessible or not. type: - boolean - 'null' x-go-name: PublicAccessibility x-go-package: magneto/base/cloud_deploy.pb 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 SchedulingPolicyProto_ContinuousSchedule: type: object properties: backupIntervalMins: description: 'If this field is set, backups will be performed periodically every ''interval_mins'' number of minutes. NOTE: This is the interval between the start time of two successive backups.' type: - integer - 'null' format: int64 x-go-name: BackupIntervalMins x-go-package: magneto/base/policy.pb ArchivalTarget: description: 'Message that specifies the details about an archival target (such as cloud or tape) where backup snapshots may be archived to.' type: object properties: name: description: The name of the archival target. type: - string - 'null' x-go-name: Name type: description: The type of the archival target. type: - integer - 'null' format: int32 x-go-name: Type vaultId: description: The id of the archival vault. type: - integer - 'null' format: int64 x-go-name: VaultId x-go-package: magneto/base/policy.pb 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 SharepPointSiteBackupEnvParams: description: 'Message to capture any additional backup params for SharePoint within the Office365 environment.' type: object properties: docLibFilteringPolicy: description: 'The filtering policy describes which objects within a source should be excluded within the backup. If this is not specified, then all of the objects within the source will be backed up. NOTE: This filtering policy assumes the paths within a site. The first token will specify a doc library name.' $ref: '#/components/schemas/FilteringPolicyProto' x-go-package: magneto/base/env_params.pb 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 EnvBackupParams: description: 'Message to capture any additional environment specific backup params at the job level.' type: object properties: exchangeBackupJobParams: description: This is applicable to Exchange environments. $ref: '#/components/schemas/ExchangeBackupJobParams' fileStubbingParams: description: This is applicable to stubbing in NAS environments. $ref: '#/components/schemas/FileStubbingParams' fileUptieringParams: description: This is applicable to uptiering in NAS environments. $ref: '#/components/schemas/FileUptieringParams' hypervBackupParams: description: This is applicable to HyperV type of environments. $ref: '#/components/schemas/HyperVBackupEnvParams' nasBackupParams: description: This is applicable to NAS type of environments. $ref: '#/components/schemas/NasBackupParams' nosqlBackupJobParams: description: This is applicable to NoSql DB environments. $ref: '#/components/schemas/NoSqlBackupJobParams' o365BackupParams: description: This is applicable to stubbing in o365 environments. $ref: '#/components/schemas/O365BackupEnvParams' oracleBackupJobParams: description: This is applicable to Oracle environments. $ref: '#/components/schemas/OracleBackupJobParams' outlookBackupParams: description: This is applicable to Outlook type of environments. $ref: '#/components/schemas/OutlookBackupEnvParams' physicalBackupParams: description: This is applicable to Physical type of environments. $ref: '#/components/schemas/PhysicalBackupEnvParams' snapshotManagerParams: description: This is applicable to snapshot manager jobs. $ref: '#/components/schemas/SnapshotManagerParams' sqlBackupJobParams: description: This is applicable to SQL environments. $ref: '#/components/schemas/SqlBackupJobParams' vmwareBackupParams: description: This is applicable to VMware type of environments. $ref: '#/components/schemas/VMwareBackupEnvParams' x-go-package: magneto/base/env_params.pb KeystoneACLProto: description: 'Protobuf that describes the Keystone access control list (ACL) permissions for a swift container. Note: Keystone ACL is applicable for only keystone authenticated users.' type: object properties: readGrantees: description: Grantees with read permission. $ref: '#/components/schemas/KeystoneACLProto_Grantees' writeGrantees: description: Grantees with write permission. $ref: '#/components/schemas/KeystoneACLProto_Grantees' x-go-package: bridge/s3_portal/base/s3_metadata.pb ProtectionSourcesSummaryStats: description: 'Specifies Job Run (Snapshot) summary statistics about the specified leaf Protection Source Object (such as a VM).' type: object title: Protection Sources Summary Statistics. properties: firstFailedRunTimeUsecs: description: 'Specifies the start time of the first failed Job Run protecting this Protection Source Object. The time is specified as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: FirstFailedRunTimeUsecs firstSuccessfulRunTimeUsecs: description: 'Specifies the start time of the first successful Job Run protecting this Protection Source Object. The time is specified as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: FirstSuccessfulRunTimeUsecs lastFailedRunTimeUsecs: description: 'Specifies the start time of the last failed Job Run protecting this Protection Source Object. The time is specified as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: LastFailedRunTimeUsecs lastRunEndTimeUsecs: description: 'Specifies the end time of the last Job Run protecting this Protection Source Object. The time is specified as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: LastRunEndTimeUsecs lastRunErrorMsg: description: 'Specifies the error message associated with last run, if the last run has failed.' type: - string - 'null' x-go-name: LastRunErrorMsg lastRunStartTimeUsecs: description: 'Specifies the start time of the last Job Run protecting this Protection Source Object. The time is specified as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: LastRunStartTimeUsecs lastRunStatus: description: 'Specifies the Job Run status of the last Job Run protecting this Protection Source Object. ''kSuccess'' indicates that the Job Run was successful. ''kRunning'' indicates that the Job Run is currently running. ''kWarning'' indicates that the Job Run was successful but warnings were issued. ''kCancelled'' indicates that the Job Run was canceled. ''kError'' indicates the Job Run encountered an error and did not run to completion.' type: - string - 'null' enum: - kSuccess - kRunning - kWarning - kCancelled - kError x-go-name: LastRunStatus lastRunType: description: 'Specifies the Job Run type of the last Job Run protecting this Protection Source Object. ''kRegular'' indicates an incremental (CBT) backup. Incremental backups utilizing CBT (if supported) are captured of the target protection objects. The first run of a kRegular schedule captures all the blocks. ''kFull'' indicates a full (no CBT) backup. A complete backup (all blocks) of the target protection objects are always captured and Change Block Tracking (CBT) is not utilized. ''kLog'' indicates a Database Log backup. Capture the database transaction logs to allow rolling back to a specific point in time. ''kSystem'' indicates system volume backup. It produces an image for bare metal recovery.' type: - string - 'null' enum: - kRegular - kFull - kLog - kSystem x-go-name: LastRunType lastSuccessfulRunTimeUsecs: description: 'Specifies the start time of the last successful Job Run protecting this Protection Source Object. The time is specified as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: LastSuccessfulRunTimeUsecs numDataReadBytes: description: 'Specifies the total number of bytes read while protecting this Protection Source Object.' type: - integer - 'null' format: int64 x-go-name: NumDataReadBytes numErrors: description: 'Specifies the total number of errors reported during Job Runs of this Protection Source Object.' type: - integer - 'null' format: int32 x-go-name: NumErrors numLogicalBytesProtected: description: 'Specifies the total logical bytes protected for this Protection Source Object. The logical size is when the data is fully hydrated or expanded.' type: - integer - 'null' format: int64 x-go-name: NumLogicalBytesProtected numSnapshots: description: 'Specifies the total number of Snapshots that are backing up this Protection Source Object.' type: - integer - 'null' format: int32 x-go-name: NumSnapshots numSuccessRuns: description: 'Specifies the total number of successful Job Runs protecting this Protection Source Object.' type: - integer - 'null' format: int32 x-go-name: NumSuccessRuns numWarnings: description: 'Specifies the total number of warnings reported during Job Runs of this Protection Source Object.' type: - integer - 'null' format: int32 x-go-name: NumWarnings protectionSource: description: 'Specifies the leaf Protection Source Object (such as VM). Snapshot summary statistics are reported for this Protection Source Object.' allOf: - $ref: '#/components/schemas/ProtectionSource' registeredSource: description: 'Specifies the name of the Registered Source that is the top level parent of the specified Protection Source Object.' type: - string - 'null' x-go-name: RegisteredSourceName tenants: description: 'Specifies basic information about tenants having access to the protection job.' type: - array - 'null' items: $ref: '#/components/schemas/TenantInfo' x-go-name: Tenants 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 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 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 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 Preferences: type: object title: User's preferences. properties: locale: description: 'Locale reflects the language settings of the user. Populate using the user preferences stored in Scribe for the user wherever needed.' type: - string - 'null' x-go-name: Locale x-go-package: cohesity/iris/server/data/public CassandraAdditionalParams: description: 'Contains additional parameters required by the agents to backup data from Cassandra.' type: object properties: cassandraClasspathSuffix: description: Cassandra classpath suffix. type: - string - 'null' x-go-name: CassandraClasspathSuffix cassandraPartitioner: description: Required in compaction. type: - string - 'null' x-go-name: CassandraPartitioner cassandraVersion: description: 'Cassandra and DSE Versions. Discovery code will attempt to discover the versions.' type: - string - 'null' x-go-name: CassandraVersion dataCenterVec: description: Data center information is required for backup and recovery. type: - array - 'null' items: type: string x-go-name: DataCenterVec dseSolrInfo: description: In case this Cassandra has a Solr node. $ref: '#/components/schemas/DSESolrInfo' dseVersion: type: - string - 'null' x-go-name: DseVersion tieredStorageDirsMap: description: Map of nodes to tiered storage directories type: - array - 'null' items: $ref: '#/components/schemas/NodeToTieredStorageDirectoriesMap' x-go-name: TieredStorageDirsMap x-go-package: magneto/base/nosql.pb PreferredDomainController: description: Specifies Preferred domain controllers (DCs) for an Active Directory domain. type: object title: Update Preferred Domain Controller Request. properties: domainControllers: description: 'List of Domain controllers DCs in FQDN format that are mapped to an Active Directory Domain name.' type: - array - 'null' items: type: string x-go-name: DomainControllers domainName: description: Specifies the Domain name or the trusted domain of an Active Directory. type: - string - 'null' x-go-name: DomainName 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 IndexingPolicyProto: description: Proto to encapsulate file level indexing policy for VMs in a backup job. type: object title: Indexing Policy Proto. properties: allowPrefixes: description: List of directory prefixes to allow for indexing. type: - array - 'null' items: type: string x-go-name: AllowPrefixes denyPrefixes: description: List of directory prefixes to filter out. type: - array - 'null' items: type: string x-go-name: DenyPrefixes disableIndexing: description: If this field is set all the files in the VM will be filtered. type: - boolean - 'null' x-go-name: DisableIndexing x-go-package: magneto/base/env_params.pb 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 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 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 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 BackupJobProto_BackupSource: type: object properties: entities: description: 'Source entities. NOTE: Multiple sources can be specified here for non-leaf-level entities in the hierarchy. The sources obtained after expanding these will be intersected among each other to form the final set of sources. e.g. this can be used to backup only those VMs that have both the tags ''SQL'' and ''3hrs''.' type: - array - 'null' items: $ref: '#/components/schemas/EntityProto' x-go-name: Entities x-go-package: magneto/base/magneto.pb 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 KeyValuePair: description: Specifies a key/value pair. type: object title: Key Value Pair. properties: key: description: Specifies the name of the key. type: - string - 'null' x-go-name: Key value: description: Specifies a value for the key. $ref: '#/components/schemas/Value' x-go-package: stats/base/stats_types.pb 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 TenantConfig: description: Specifies struct with basic tenant specific configuration. type: object title: Tenant Config. properties: name: description: Specifies name of the tenant. type: - string - 'null' x-go-name: Name restricted: description: 'Whether the user is a restricted user. A restricted user can only view the objects he has permissions to.' type: - boolean - 'null' x-go-name: Restricted roles: description: 'Array of Roles. Specifies the Cohesity roles to associate with the user such as such as ''Admin'', ''Ops'' or ''View''. The Cohesity roles determine privileges on the Cohesity Cluster for this user.' type: - array - 'null' items: type: string x-go-name: Roles tenantId: description: Specifies the unique id of the tenant. type: - string - 'null' x-go-name: TenantId x-go-package: cohesity/iris/server/data/public 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 OracleDBChannelInfo: description: 'Note: The name of this proto message is out-dated. This proto can represent more than just the database channel information. It should be renamed in the future.' type: object title: 'Message to contain backup or restore parameters for a unique Oracle database. The Oracle database unique name is used to determine uniqueness of the database.' properties: archivelogKeepDays: description: 'Archived log deletion policy for this unique Oracle database. 1: keep archived log forever 0: delete archived log immediately n>0: delete archived log after n days' type: - integer - 'null' format: int32 x-go-name: ArchivelogKeepDays dbUniqueName: description: The unique name of the database. type: - string - 'null' x-go-name: DbUniqueName dbUuid: description: 'Database id, internal field, is filled by magneto master based on corresponding app entity id.' type: - string - 'null' x-go-name: DbUuid enableDgPrimaryBackup: description: 'If set to false, and if the DG database role is primary, we will not allow the backup of that database.' type: - boolean - 'null' x-go-name: EnableDgPrimaryBackup hostInfoVec: description: 'Vector of Oracle hosts from which we are allowed to take the backup/restore. In case of RAC database it may be more than one.' type: - array - 'null' items: $ref: '#/components/schemas/OracleDBChannelInfo_HostInfo' x-go-name: HostInfoVec maxNumHost: description: 'Maximum number of hosts from which we are allowed to take backup/restore parallely. This will be less than or equal to host_info_vec_size. If this is less than host_info_vec_size we will choose max_num_host from host_info_vec and take backup/restore from this number of host.' type: - integer - 'null' format: int32 x-go-name: MaxNumHost numChannels: description: 'The default number of channels to use per host per db. This value is used on all hosts unless host_info_vec.num_channels is specified for that host. Default value for num_channels will be calculated as minimum number of nodes in cohesity cluster, and 2 * number of cpu on Oracle host. Preference order for number of channels per host for given db is: 1. If user has specified host_info_vec.num_channels for host we will use that. 2. If user has not specified host_info_vec.num_channels but specified num_channels we will use this. 3. If user has neither specified host_info_vec.num_channels nor num_channels we will calculate default channels with above formula.' type: - integer - 'null' format: int32 x-go-name: NumChannels rmanBackupType: description: Type of Oracle RMAN backup rquested (i.e ImageCopy, BackupSets). type: - integer - 'null' format: int32 x-go-name: RmanBackupType x-go-package: magneto/base/env_params.pb 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 ExchangeBackupJobParams: description: Message to capture additional backup job params specific to Exchange. type: object title: Exchange Backup Job Parameters. properties: isCopyOnlyFull: description: 'Whether the backups should be copy-only. If this is set to true, then Exchange server will not truncate logs after backup.' type: - boolean - 'null' x-go-name: IsCopyOnlyFull x-go-package: magneto/base/env_params.pb 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 ProtectionTrend: description: Specifies details of a protected object with it's protection trends. type: object title: Protection Trend. properties: cancelled: description: Specifies number of cancelled runs across trends. type: - integer - 'null' format: int64 x-go-name: Cancelled environment: description: 'Specifies 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 failed: description: Specifies number of failed runs across trends. type: - integer - 'null' format: int64 x-go-name: Failed id: description: Specifies protected object's Id. type: - integer - 'null' format: int64 x-go-name: Id name: description: Specifies protected object's name. type: - string - 'null' x-go-name: Name parentSourceId: description: Specifies protected object's parent id. type: - integer - 'null' format: int64 x-go-name: ParentSourceId parentSourceName: description: Specifies protected object's parent name. type: - string - 'null' x-go-name: ParentName running: description: Specifies number of in-progress runs across trends. type: - integer - 'null' format: int64 x-go-name: Running successful: description: Specifies number of successful runs across trends. type: - integer - 'null' format: int64 x-go-name: Successful total: description: Specifies total number of runs across trends. type: - integer - 'null' format: int64 x-go-name: Total trends: description: Aggregated protection runs information by days/weeks. type: - array - 'null' items: $ref: '#/components/schemas/TrendingData' x-go-name: Trends 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 ProtectionSourceSnapshotInformation: description: 'Specifies details about a Snapshot that backups up a leaf Protection Source Object.' type: object title: Protection Source Snapshot. properties: copyTasks: description: 'Array of Snapshot Copy Tasks. Specifies a list of copy tasks (such as replication and archival tasks).' type: - array - 'null' items: $ref: '#/components/schemas/SnapshotCopyTask' x-go-name: CopyTasks jobId: description: Specifies the id of the Protection Job. type: - integer - 'null' format: int64 x-go-name: JobId jobName: description: Specifies the name of the Protection Job. type: - string - 'null' x-go-name: JobName jobRunId: description: Specifies the id of the Job Run. type: - integer - 'null' format: int64 x-go-name: JobRunId jobRunStartTimeUsecs: description: 'Specifies the start time of the Job which this object is part of. The time is specified in Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: JobRunStartTimeUsecs lastRunEndTimeUsecs: description: 'Specifies the end time of the last Run of this object''s snapshot. The time is specified in Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: LastRunEndTimeUsecs lastRunStartTimeUsecs: description: 'Specifies the start time of the last Run of this object''s snapshot. The time is specified in Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: LastRunStartTimeUsecs message: description: 'Specifies warning or error information when the Job Run is not successful.' type: - string - 'null' x-go-name: Message numBytesRead: description: Specifies the total number of bytes read. type: - integer - 'null' format: int64 x-go-name: NumBytesRead numLogicalBytesProtected: description: 'Specifies the total number of logical bytes that are protected. The logical size is when the data is fully hydrated or expanded.' type: - integer - 'null' format: int64 x-go-name: NumLogicalBytesProtected paginationCookie: description: 'Specifies an opaque string to pass into the next request to get the next set of Snapshots for pagination purposes. If null, this is the last set of Snapshots or the number of Snapshots returned is equal to or less than the specified pageCount.' type: - integer - 'null' format: uint64 x-go-name: PaginationCookie runStatus: description: 'Specifies the type of the Job Run. ''kSuccess'' indicates that the Job Run was successful. ''kRunning'' indicates that the Job Run is currently running. ''kWarning'' indicates that the Job Run was successful but warnings were issued. ''kCancelled'' indicates that the Job Run was canceled. ''kError'' indicates the Job Run encountered an error and did not run to completion.' type: - string - 'null' enum: - kSuccess - kRunning - kWarning - kCancelled - kError x-go-name: RunStatus runType: description: 'Specifies the status of the Job Run. ''kRegular'' indicates an incremental (CBT) backup. Incremental backups utilizing CBT (if supported) are captured of the target protection objects. The first run of a kRegular schedule captures all the blocks. ''kFull'' indicates a full (no CBT) backup. A complete backup (all blocks) of the target protection objects are always captured and Change Block Tracking (CBT) is not utilized. ''kLog'' indicates a Database Log backup. Capture the database transaction logs to allow rolling back to a specific point in time. ''kSystem'' indicates system volume backup. It produces an image for bare metal recovery.' type: - string - 'null' enum: - kRegular - kFull - kLog - kSystem x-go-name: ScheduleType x-go-package: cohesity/iris/server/data/public GranteeProto: type: object title: Message to define a grantee to which ACL permissions can be granted. properties: emailAddress: description: 'If grantee is of type ''kEmailUser'', this field will contain the email address of the user.' type: - string - 'null' x-go-name: EmailAddress group: description: 'If grantee is of type ''kGroup'', this field will contain the group to which permission is granted.' type: - integer - 'null' format: int32 x-go-name: Group type: type: - integer - 'null' format: int32 x-go-name: Type userId: description: 'If grantee is of type ''kRegisteredUser'', this field will contain the canonical id of the user.' type: - string - 'null' x-go-name: UserId x-go-package: bridge/s3_portal/base/s3_metadata.pb 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 VMwareBackupSourceParams: description: Message to capture additional backup params for a VMware type source. type: object title: VMware Backup Source Parameters. properties: sourceAppParams: description: 'This message will capture params for applications that are running as part of the server.' $ref: '#/components/schemas/SourceAppParams' vmCredentials: description: 'Target entity credentials. This should usually be set if the source_app_params is set, i.e any additional operations that require access within the guest.' $ref: '#/components/schemas/Credentials' vmwareDiskExclusionInfo: description: 'List of Virtual Disk(s) to be excluded from the backup job for the source. Overrides the exclusion list requested (if any) through EnvBackupParams.VMwareBackupEnvParams.' type: - array - 'null' items: $ref: '#/components/schemas/VMwareDiskExclusionProto' x-go-name: VmwareDiskExclusionInfo x-go-package: magneto/base/env_params.pb DataTransferFromVaultPerTask: description: 'Specifies statistics about the transfer of data from a Vault (External Target) to this Cohesity Cluster for a recover or clone task.' type: object title: Data Transfer From Vault Per Task. properties: numLogicalBytesTransferred: description: 'Specifies the total number of logical bytes that are transferred from this Vault to the Cohesity Cluster for this task. The logical size is when the data is fully hydrated or expanded.' type: - integer - 'null' format: int64 x-go-name: NumLogicalBytesTransferred numPhysicalBytesTransferred: description: 'Specifies the total number of physical bytes that are transferred from this Vault to the Cohesity Cluster for this task.' type: - integer - 'null' format: int64 x-go-name: NumPhysicalBytesTransferred taskName: description: Specifies the task name. type: - string - 'null' x-go-name: TaskName taskType: description: Specifies the task type. type: - string - 'null' x-go-name: TaskType 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 AlertingPolicyProto: type: object properties: deliveryTargetVec: description: The delivery targets to be alerted. type: - array - 'null' items: $ref: '#/components/schemas/DeliveryRuleProto_DeliveryTarget' x-go-name: DeliveryTargetVec emails: description: 'The email addresses to send alerts to. This field has been deprecated in favor of the field delivery_target_vec. The clients should take care to ensure that the emails stored in here are migrated to that field, or else utilise both the fields when trying to obtain the complete list of delivery targets.' type: - array - 'null' items: type: string x-go-name: Emails policy: description: '''policy'' is declared as int32 because ORing the enums will generate values which are invalid as enums. Protobuf doesn''t allow those invalid enums to be set.' type: - integer - 'null' format: int32 x-go-name: Policy raiseObjectLevelFailureAlert: description: Raise per object alert for failures. type: - boolean - 'null' x-go-name: RaiseObjectLevelFailureAlert x-go-package: magneto/base/env_params.pb 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 SwiftContainerTaggingProto: type: object title: Proto to define the tagging info associated with a Swift container. properties: aclRootUser: description: '[optional] The Keystone user who could get grant of access to this container after creation by ACL. It is used to let this user get access to this container if noboby has any Swift roles from Keystone. If this user has a Swift role, other Keystone users could get grant by this ''root'' user through ACL. If ''acl_root_user'' is set, below fields are mandatory. [mandatory] acl_root_user.name [mandatory] acl_root_user.domain.name' $ref: '#/components/schemas/User' projectTag: description: '[mandatory] The Keystone project this Swift container belongs to. Below fields are mandatory. [mandatory] project_tag.name [mandatory] project_tag.domain.name' $ref: '#/components/schemas/Project' x-go-package: bridge/s3_portal/base/s3_metadata.pb RemoteHostConnectorParams: type: object title: Contains parameters to connect to a remote host. properties: credentials: description: 'Credentials that will be used to login to the remote host. For env of type kLinux, it is expected that user has setup the password-less access to the remote host. So only username field MUST be specified.' $ref: '#/components/schemas/Credentials' hostAddress: description: 'Address (i.e., IP, hostname or FQDN) of the host to connect to. Magneto will connect using ssh or equivalent to the host.' type: - string - 'null' x-go-name: HostAddress hostType: description: Type of host to connect to. type: - integer - 'null' format: int32 x-go-name: HostType x-go-package: magneto/base/magneto.pb 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 VlanParams: type: object title: Contains vlan params associated with the backup/restore operation. properties: disableVlan: description: 'If this is set to true, then even if VLANs are configured on the system, the partition VIPs will be used for the restore.' type: - boolean - 'null' x-go-name: DisableVlan interfaceName: description: 'Interface group to use for restore. If this is not specified, primary interface group for the cluster will be used.' type: - string - 'null' x-go-name: InterfaceName vlanId: description: 'If this is set, then the Cohesity host name or the IP address associated with this vlan is used for mounting Cohesity''s view on the remote host.' type: - integer - 'null' format: int32 x-go-name: VlanId x-go-package: magneto/base/common.pb 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 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 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 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 KeystoneACLProto_Grantees_ProjectUsers: type: object properties: userIdVec: type: - array - 'null' items: type: string x-go-name: UserIdVec x-go-package: bridge/s3_portal/base/s3_metadata.pb 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 OneDriveBackupEnvParams: description: 'Message to capture any additonal backup params for OneDrive within the Office365 environment.' type: object title: Onedrive Backup Environment Parameters. properties: filteringPolicy: description: 'The filtering policy describes which objects within a source should be excluded within the backup. If this is not specified, then all of the objects within the source will be backed up.' $ref: '#/components/schemas/FilteringPolicyProto' shouldBackupOnedrive: description: 'Specifies whether the OneDrive(s) for all the Office365 Users present in the protection job should be backed up.' type: - boolean - 'null' x-go-name: ShouldBackupOnedrive x-go-package: magneto/base/env_params.pb WormRetentionProto: description: 'Message that specifies the WORM attributes. WORM attributes can be associated with any of the following: 1. backup policy: compliance or administrative policy with worm retention. 2. backup runs: worm retention inherited from policy at successful backup run completion.. 3. backup tasks do not inherit WORM retention. Instead they check for WORM property on the corresponding backup run. There are no WORM attributes associated with the backup job.' type: object properties: policyType: description: 'The type of WORM policy set on this run. This field is irrelevant while objects are on legal hold. Objects put on legal hold automatically raise the WORM level on the object behaviorally to the strictest level i.e. kCompliance.' type: - integer - 'null' format: int32 x-go-name: PolicyType retentionSecs: description: Retention time for datalock in seconds. This will be always relative time. type: - integer - 'null' format: int64 x-go-name: RetentionSecs version: description: Version number for this proto. type: - integer - 'null' format: int32 x-go-name: Version x-go-package: magneto/base/worm.pb 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 BackupPolicyProto_ExclusionTimeRange: description: 'A proto to specify a time range within a single day when backups are not permitted to run.' type: object properties: day: description: If the day is not set, the time range applies to all days. type: - integer - 'null' format: int32 x-go-name: Day endTime: description: End time of the time range. $ref: '#/components/schemas/Time' startTime: description: Start time of the time range. $ref: '#/components/schemas/Time' x-go-package: magneto/base/magneto.pb SalesforceAccountInfo: description: Salesforce Account Information of a Helios user. type: object title: Salesforce Account Information. properties: accountId: description: Specifies the Account Id assigned by Salesforce. type: - string - 'null' x-go-name: AccountId userId: description: Specifies the User Id assigned by Salesforce. type: - string - 'null' x-go-name: UserId x-go-package: cohesity/iris/server/data/public 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 AWSFleetParams_Tag: type: object title: Tag information. properties: key: description: Key for the tag. type: - string - 'null' x-go-name: Key value: description: Value for the tag. type: - string - 'null' x-go-name: Value x-go-package: magneto/base/entities/aws.pb Tenant: description: Specifies details about a tenant. type: object title: Tenant Details. properties: activeDirectories: description: Specifies the active directories this tenant is associated to. type: - array - 'null' items: $ref: '#/components/schemas/ActiveDirectoryEntry' x-go-name: ActiveDirectories bifrostEnabled: description: Specifies whether bifrost (Ambassador proxy) is enabled for tenant. type: - boolean - 'null' x-go-name: BifrostEnabled clusterHostname: description: 'The hostname for Cohesity cluster as seen by tenants and as is routable from the tenant''s network. Tenant''s VLAN''s hostname, if available can be used instead but it is mandatory to provide this value if there''s no VLAN hostname to use. Also, when set, this field would take precedence over VLAN hostname.' type: - string - 'null' x-go-name: ClusterHostname clusterIps: description: 'Set of IPs as seen from the tenant''s network for the Cohesity cluster. Only one from ''ClusterHostname'' and ''ClusterIps'' is needed.' type: - array - 'null' items: type: string x-go-name: ClusterIps createdTimeMsecs: description: 'Specifies the epoch time in milliseconds when the tenant account was created on the Cohesity Cluster.' type: - integer - 'null' format: int64 x-go-name: CreatedTimeMsecs deleted: description: Specifies if the Tenant is deleted. type: - boolean - 'null' x-go-name: Deleted deletedTimeMsecs: description: Specifies the timestamp at which the tenant was deleted. type: - integer - 'null' format: int64 x-go-name: DeletedTimeMsecs deletionFinished: description: Specifies if the object collection is complete for the tenant. type: - boolean - 'null' x-go-name: DeletionFinished deletionInfoVec: description: Specifies the current deletion state of object categories. type: - array - 'null' items: $ref: '#/components/schemas/TenantDeletionInfo' x-go-name: DeletionInfo description: description: Specifies the description of this tenant. type: - string - 'null' x-go-name: Description entityIds: description: Specifies the EntityIds this tenant is associated to. type: - array - 'null' items: type: integer format: int64 x-go-name: EntityIds lastUpdatedTimeMsecs: description: 'Specifies the epoch time in milliseconds when the tenant account was last modified on the Cohesity Cluster.' type: - integer - 'null' format: int64 x-go-name: LastUpdatedTimeMsecs ldapProviders: description: Specifies the ldap providers this tenant is associated to. type: - array - 'null' items: $ref: '#/components/schemas/LdapProviderResponse' x-go-name: LdapProviders name: description: Specifies the name of the tenant. type: - string - 'null' x-go-name: Name orgSuffix: description: 'Specifies the organization suffix needed to construct tenant id. Tenant id is not completely auto generated rather chosen by tenant/SP admin as we needed same tenant id on multiple clusters to support replication across clusters, etc.' type: - string - 'null' x-go-name: OrgSuffix parentTenantId: description: Specifies the parent tenant of this tenant if available. type: - string - 'null' x-go-name: ParentTenantId policyIds: description: Specifies the PolicyIds this tenant is associated to. type: - array - 'null' items: type: string x-go-name: PolicyIds protectionJobs: description: Specifies the ProtectionJobs this tenant is associated to. type: - array - 'null' items: $ref: '#/components/schemas/BackupJobProto' x-go-name: ProtectionJobs subscribeToAlertEmails: description: Service provider can optionally unsubscribe from the Tenant Alert Emails. type: - boolean - 'null' x-go-name: SubscribeToAlertEmails swiftConfig: description: Specifies the Swift configuration of this tenant. $ref: '#/components/schemas/SwiftParams' tenantId: description: Specifies the unique id of the tenant. type: - string - 'null' x-go-name: TenantId viewBoxIds: description: Specifies the ViewBoxIds this tenant is associated to. type: - array - 'null' items: type: integer format: int64 x-go-name: ViewBoxIds views: description: Specifies the Views this tenant is associated to. type: - array - 'null' items: $ref: '#/components/schemas/View' x-go-name: Views vlanIfaceNames: description: 'Specifies the VlanIfaceNames this tenant is associated to, in the format of bond1.200.' type: - array - 'null' items: type: string x-go-name: VlanIfaceNames 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 DeployDBInstancesToRDSParams_PointInTimeRestoreParams: description: 'Message to capture details of a point in time that the DB needs to be restored to.' type: object properties: timestampMsecs: description: Time in milliseconds since epoch that the DB needs to be restored to. type: - integer - 'null' format: int64 x-go-name: TimestampMsecs x-go-package: magneto/base/cloud_deploy.pb 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 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 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 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 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 DataTransferToVaultsSummaryResponse: description: 'Provides summary statistics about the transfer of data from this Cohesity Cluster to Vaults (External Targets).' type: object title: Data Transfer to Vaults Summary Response. properties: dataTransferSummary: description: 'Array of Summary Data Transfer Statistics. Specifies summary statistics about the transfer of data from the Cohesity Cluster to Vaults.' type: - array - 'null' items: $ref: '#/components/schemas/DataTransferToVaultSummary' x-go-name: DataTransferSummary x-go-package: cohesity/iris/server/data/public KeystoneACLProto_Grantees_ProjectUsersMapEntry: type: object properties: key: type: - string - 'null' x-go-name: Key value: $ref: '#/components/schemas/KeystoneACLProto_Grantees_ProjectUsers' x-go-package: bridge/s3_portal/base/s3_metadata.pb PublicFoldersBackupEnvParams: description: 'Message to capture any additional backup params for Public Folders within Office365 environment.' type: object title: O365 PublicFolders Backup Environment Parameters. properties: filteringPolicy: description: 'The filtering policy describes which paths within a Public Folder should be excluded within the backup. If this is not specified, then the entire Public Folders will be backed up.' $ref: '#/components/schemas/FilteringPolicyProto' x-go-package: magneto/base/env_params.pb SnapshotTargetPolicyProto: description: 'Message that specifies the policy for copying backup snapshots to a target. This message also specifies the retention policy that should be applied to the snapshots after they have been copied to the specified target.' type: object title: Snapshot Target Policy Proto. properties: copyPartiallySuccessfulRun: description: 'If this is false, then only snapshots from the first completely successful run in the given time granularity will be considered for being copied. If this is true, then snapshots from the first partially successful run will also be eligible to be copied.' type: - boolean - 'null' x-go-name: CopyPartiallySuccessfulRun granularityBucket: description: 'Specifies the frequency at which the backup job''s snapshots should be copied to the specified target.' $ref: '#/components/schemas/GranularityBucket' id: description: 'This id uniquely identifies this entry in the ProtectionPolicyProto. If this message is from global policy, this id is generated by Helios. Otherwise, it is generated by Iris. Magneto uses this for merging linked policies with its parent global policy.' type: - string - 'null' x-go-name: Id numDaysToKeep: description: 'Specifies how to determine the expiration time for snapshots copied due to this policy. The snapshots will be marked as expiring (i.e., eligible to be garbage collected) in ''num_days_to_keep'' days from when the snapshots were created.' type: - integer - 'null' format: int64 x-go-name: NumDaysToKeep retentionPolicy: description: 'The retention that applies to the snapshots on the target (after they have been copied there).' $ref: '#/components/schemas/RetentionPolicyProto' snapshotTarget: description: The target where the backup snapshots should be copied to. $ref: '#/components/schemas/SnapshotTarget' x-go-package: magneto/base/policy.pb ProtectionSourcesJobRunsReportElement: description: Specifies a Protection Source and the Snapshots that back it up. type: object title: Protection Source and Snapshots. properties: protectionSource: description: Specifies the leaf Protection Source Object such as a VM. allOf: - $ref: '#/components/schemas/ProtectionSource' snapshotsInfo: description: 'Array of Snapshots Specifies the Snapshots that contain backups of the Protection Source Object.' type: - array - 'null' items: $ref: '#/components/schemas/ProtectionSourceSnapshotInformation' x-go-name: SnapshotsInfo 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 BackupPolicyProto_OneOffSchedule: type: object properties: time: description: The time when the one-off backup should be performed. $ref: '#/components/schemas/Time' x-go-package: magneto/base/magneto.pb CassandraBackupJobParams: description: 'Contains any additional cassandra environment specific backup params at the job level.' type: object properties: cassandraAdditionalInfo: description: Additional parameters required for Cassandra backup. $ref: '#/components/schemas/CassandraAdditionalParams' selectedDataCenterVec: description: The data centers selected for backup. type: - array - 'null' items: type: string x-go-name: SelectedDataCenterVec x-go-package: magneto/base/nosql.pb 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 PhysicalBackupEnvParams: description: Message to capture any additional backup params for a Physical environment. type: object title: Physical Backup Environment Parameters. properties: enableIncrementalBackupAfterRestart: description: 'If this is set to true, then incremental backup will be performed after the server restarts, otherwise a full-backup will be done. NOTE: This is applicable to windows host environments.' type: - boolean - 'null' x-go-name: EnableIncrementalBackupAfterRestart filteringPolicy: description: 'The filtering policy to decide which objects within a source should be backed up. If this is not specified, then all of the objects within the source will be backed up.' $ref: '#/components/schemas/FilteringPolicyProto' x-go-package: magneto/base/env_params.pb 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 Links: description: 'The links proto to a specific resource. For example, resource, can be domain, endpoint or service.' type: object properties: next: type: - string - 'null' x-go-name: Next previous: type: - string - 'null' x-go-name: Previous self: type: - string - 'null' x-go-name: Self x-go-package: bridge/s3_portal/keystone/keystone2.pb 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 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 RangeFilterParams: description: Specifies the filters that are applied on attributes. type: object properties: lowerBound: description: Specifies the lower bound value. If specified, all the results which are greater than this value will be returned. type: - integer - 'null' format: int64 x-go-custom-tag: bson:"lowerBound,omitempty" upperBound: description: Specifies the upper bound value. If specified, all the results which are lesser than this value will be returned. type: - integer - 'null' format: int64 x-go-custom-tag: bson:"upperBound,omitempty" AggregatedAttributesParams: description: Specifies list of aggregation properties to be applied on the attributes. type: object required: - aggregationType - attribute properties: aggregationType: description: Specifies the aggregation type. type: - string - 'null' enum: - sum - count - min - max - avg - countDistinct attribute: description: Specifies the attribute name. type: - string - 'null' label: description: Specifies the label to be generated for this aggregated attribute. If not specified, then by default label of the column in the output will be combination of aggregation type and attribute type: - string - 'null' ReportTypeAttribute: description: Specifies an attribute and its properties for a given report type. type: object properties: name: description: Specifies the attribute name. type: string dataType: description: Specifies the data type of the attribute. type: string enum: - Bool - String - Int64 - Int32 - StringArray - Int64Array - Float64 ReportTypeAttributes: description: Specifies list of attributes and properties for a given report type. type: object properties: attributes: description: Specifies the attribute name. type: array items: $ref: '#/components/schemas/ReportTypeAttribute' ReportPreviewParams: description: Specifies preview of a Report. type: object properties: timezone: description: Specifies timezone of the user. If nil, defaults to UTC. The time specified should be a location name in the IANA Time Zone database, for example, 'America/Los_Angeles' type: - string - 'null' componentIds: description: Specifies list of components ids to be evaluated for the given report. If not specified, then all the components are evaluated. type: - array - 'null' items: type: string filters: description: Specifies list of global filters that are applicable to given components in the report. type: - array - 'null' items: $ref: '#/components/schemas/AttributeFilter' ReportPreview: description: Specifies preview of a Report. type: object properties: id: description: Specifies the id of the report. type: - string - 'null' title: description: Specifies the title of the report. type: - string - 'null' components: description: Specifies the component params and data. type: - array - 'null' items: $ref: '#/components/schemas/Component' filters: description: Specifies list of global filters that are applicable to given components in the report. type: - array - 'null' items: $ref: '#/components/schemas/AttributeFilter' timezone: description: Specifies timezone of the user. If nil, defaults to UTC. The time specified should be a location name in the IANA Time Zone database, for example, 'America/Los_Angeles' type: - string - 'null' generatedTimestampUsecs: description: Specifies the epoch timestamp in UTC in microseconds. type: - integer - 'null' format: int64 TenantsFilterParams: description: 'Specifies the tenants filter. Specifying this will pre filter all the results with provided list of tenants before applying aggregations.' type: object properties: includeTenants: description: 'Specifies whether to include tenants. Defaults to true. If false, it will not consider below filters. False will result in no data for helios tenant or dmaas user.' type: - boolean - 'null' x-go-custom-tag: bson:"includeTenants,omitempty" tenantNames: description: Specifies the optional tenant names labels. type: array items: type: string x-go-custom-tag: bson:"tenantNames,omitempty" tenantIds: description: 'Specifies an array of tenant identifiers. Provide local tenant identifiers.' type: array items: type: string minItems: 1 x-go-custom-tag: bson:"tenantIds,omitempty" LimitParams: description: Specifies the parameters to limit the resulting dataset. type: object required: - size properties: from: description: Specifies the offset to which resulting data will be skipped before applying the size parameter. For example if dataset size is 10 objects, from=2 and size=5, then from 10 objects only 5 objects are returned starting from offset 2 i.e., 2 to 7. If not specified, then none of the objects are skipped. type: - integer - 'null' size: description: Specifies the number of objects to be returned from the offset specified. type: integer minimum: 1 AttributeAggregations: description: Specifies the aggregation related information that needs to be applied on the attributes. type: object properties: groupedAttributes: description: Specifies list of attributes to be grouped in the aggregation. type: array items: type: string aggregatedAttributes: description: Specifies list of aggregation properties to be applied on the attributes. type: - array - 'null' items: $ref: '#/components/schemas/AggregatedAttributesParams' Report: description: Specifies a Report. type: object properties: id: description: Specifies the id of the report. type: - string - 'null' title: description: Specifies the title of the report. type: - string - 'null' description: description: Specifies description of the Report. type: - string - 'null' category: description: Specifies categoty of the Report. type: - string - 'null' enum: - Protection - Storage - Compliance supportedUserContexts: description: Specifies all the supported user contexts for this report. type: array items: type: string enum: - DMaaS - Hybrid - MCM - MCMTenant - FortKnox componentIds: description: Specifies the list of component ids in the Report. type: - array - 'null' items: type: - string - 'null' XlsxAttributeCustomConfigParams: description: Specifies the configuration parameters to customize the columns in excel report for a component. The ordering of the columns in the resulting xlsx will be done according to the order they are configured. type: object required: - attributeName properties: attributeName: description: Specifies the name of the attribute. type: - string - 'null' customLabel: description: Specifies a custom label for attribute to appear in the xlsx report. If not specified, default attribute name will be used. type: - string - 'null' format: description: Specifies a custom format for attribute to appear in the xlsx report. If not specified, the attribute value is sent as-is. type: string enum: - Timestamp - Duration TimeRangeFilterParams: description: Specifies the time range filter. Specifying this will pre filter all the results on necessary resources like Protection Runs etc before applying aggregations. Currently, maximum allowed time range is 60 days. type: object properties: lowerBound: description: Specifies the lower bound value. If specified, all the results which are greater than this value will be returned. type: - integer - 'null' format: int64 x-go-custom-tag: bson:"lowerBound,omitempty" upperBound: description: Specifies the upper bound value. If specified, all the results which are lesser than this value will be returned. type: - integer - 'null' format: int64 x-go-custom-tag: bson:"upperBound,omitempty" durationHours: description: Specifies the duration preceding the current time for which the data must be fetch i.e fetch data between currentTime and currentTime - durationHours. This filter is only considered if neither upperBound, lowerBound or dateRange is specified. type: - integer - 'null' format: int64 x-go-custom-tag: bson:"durationHours,omitempty" dateRange: description: Enum value for specifying the date range for a time filter. Considered only if lowerBound and upperBound are empty. type: - string - 'null' enum: - Last1Hour - Last24Hours - Last7Days - CurrentMonth - Last30Days - LastMonth - Last90Days - Last3Months - Last180Days - Last6Months - CurrentYear - Last365Days - LastYear x-go-custom-tag: bson:"dateRange,omitempty" XlsxCustomConfigParams: description: Specifies the configuration parameters to customize a component in excel report. type: object properties: attributeConfig: description: Specifies customized configuration for the attributes in the report. If not specified, all the attributes will be sent as-is to the report without any formatting. type: - array - 'null' items: $ref: '#/components/schemas/XlsxAttributeCustomConfigParams' minItems: 1 AttributeSort: description: Specifies the sorting (ordering) parameters to be applied to the resulting data. type: object required: - attribute properties: attribute: description: Specifies the name of the attribute. type: string desc: description: Specifies whether the sorting order should be descending. Default value is false. type: - boolean - 'null' Component: description: Specifies a Report Component. type: object properties: id: description: Specifies the id of the Component. type: - string - 'null' name: description: Specifies the name of the Component. type: - string - 'null' description: description: Specifies description of the Component. type: - string - 'null' reportType: description: Specifies the report type on top of which this Component is created from. type: - string - 'null' enum: - ClusterConnections - ClusterConnectionsTrend - ProtectedUnprotectedObjects - ProtectedObjects - ProtectionActivity - ProtectionGroupSummary - ProtectionRuns - ProtectionRunsTrend - StorageConsumptionByObjects - StorageConsumptionByProtectionGroups - StorageConsumptionByClusters - StorageConsumptionByStorageDomains - StorageConsumptionByOrganizations - StorageConsumptionByClustersTrend - StorageConsumptionByViews - ServiceConsumption - ServiceConsumptionTrend - Recovery - Failures - ProtectionSummaryBySystem - DataTransferredToExternalTargets - DataTransferredToExternalTargetsTrend aggs: $ref: '#/components/schemas/AttributeAggregations' sort: description: Specifies the sorting (ordering) parameters to be applied to the resulting data. type: - array - 'null' items: $ref: '#/components/schemas/AttributeSort' limit: $ref: '#/components/schemas/LimitParams' filters: description: Specifies the filters that are applied on specific report type attributes in order to compose this component. type: - array - 'null' items: $ref: '#/components/schemas/AttributeFilter' config: $ref: '#/components/schemas/CustomConfigParams' data: description: Specifies the data returned after evaluating the component. type: array items: additionalProperties: type: object readOnly: true CustomConfigParams: description: Specifies the configuration parameters to customize and format the columns in the report artifacts like excel, pdf etc type: object properties: xlsxParams: $ref: '#/components/schemas/XlsxCustomConfigParams' ExportReportParams: description: Parameters for exporting a report. type: object properties: filters: description: Specifies list of global filters that are applicable to given components in the report. type: - array - 'null' items: $ref: '#/components/schemas/AttributeFilter' reportFormat: description: The format in which the report needs to be exported. type: - string - 'null' enum: - PDF - XLS - CSV layout: description: The layout of the report which needs to be exported. type: - string - 'null' timezone: description: Specifies timezone of the user. If nil, defaults to UTC. The time specified should be a location name in the IANA Time Zone database, for example, 'America/Los_Angeles' type: - string - 'null' async: description: Specifies if the report should be generated asynchronously type: - boolean - 'null' InFilterParams: description: Specifies the in filter that are applied on attributes. type: object required: - attributeDataType properties: attributeDataType: description: Specifies the data type of the attribute. type: - string - 'null' enum: - Bool - String - Int64 - Int32 - StringArray - Int64Array - Float64 x-go-custom-tag: bson:"attributeDataType,omitempty" attributeLabels: description: Specifies the optional label values for the attribute. type: array items: type: string x-go-custom-tag: bson:"attributeLabels,omitempty" int64FilterValues: description: Specifies list of int64 values to filter results on. type: array items: type: integer format: int64 x-go-custom-tag: bson:"int64FilterValues,omitempty" boolFilterValues: description: Specifies list of boolean values to filter results on. type: array items: type: boolean x-go-custom-tag: bson:"boolFilterValues,omitempty" stringFilterValues: description: Specifies list of string values to filter results on. type: array items: type: string x-go-custom-tag: bson:"stringFilterValues,omitempty" int32FilterValues: description: Specifies list of int32 values to filter results on. type: array items: type: integer format: int32 x-go-custom-tag: bson:"int32FilterValues,omitempty" SystemsFilterParams: description: Specifies the systems filter. Specifying this will pre filter all the results provided list of system identifier before applying aggregations. type: object required: - systemIds properties: systemNames: description: Specifies the optional system names labels. type: array items: type: string x-go-custom-tag: bson:"systemNames,omitempty" systemIds: description: Specifies an array of system identifiers. System identifiers may be of format clusterid:clusterincarnationid or a regionid (applicable only in case of DMaaS). type: array items: type: string minItems: 1 x-go-custom-tag: bson:"systemIds,omitempty" Error: description: Specifies the error object with error code and a message. type: object properties: errorCode: description: Specifies the error code. type: integer errorMessage: description: Specifies the error message. type: string Reports: description: Specifies a list of Reports. type: object properties: reports: description: Specifies list of reports. type: - array - 'null' items: $ref: '#/components/schemas/Report' AttributeFilter: description: Specifies the filters that are applied on attributes. type: object required: - attribute - filterType properties: attribute: description: Specifies the attribute. type: - string - 'null' x-go-custom-tag: bson:"attribute,omitempty" filterType: description: Specifies the type of the filter that needs to be applied. type: - string - 'null' enum: - In - Range - TimeRange - Systems - Tenants x-go-custom-tag: bson:"filterType,omitempty" inFilterParams: description: Specifies the params for applying IN filter. This will filter the results for the specified values for the specified attribute $ref: '#/components/schemas/InFilterParams' x-go-custom-tag: bson:"inFilterParams,omitempty" rangeFilterParams: description: Specifies the params for applying range filter. This will filter the results for the specified range for the specified attribute. $ref: '#/components/schemas/RangeFilterParams' x-go-custom-tag: bson:"rangeFilterParams,omitempty" timeRangeFilterParams: description: Specifies the params for applying timerange filter. This basically applies the time bound on which resources are pre filtered. $ref: '#/components/schemas/TimeRangeFilterParams' x-go-custom-tag: bson:"timeRangeFilterParams,omitempty" systemsFilterParams: description: Specifies the params for applying filter on system identifiers. $ref: '#/components/schemas/SystemsFilterParams' x-go-custom-tag: bson:"systemsFilterParams,omitempty" tenantsFilterParams: description: Specifies the params for applying filter on system identifiers. $ref: '#/components/schemas/TenantsFilterParams' x-go-custom-tag: bson:"tenantsFilterParams,omitempty" responses: GetAgentDeploymentReportResponse: description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/AgentDeploymentStatusResponse' Error: description: Error content: application/json: schema: $ref: '#/components/schemas/RequestError' GetGdprReportResponse: description: GetGdprReportResponse defines the response for GetGdprReport. content: application/json: schema: type: array items: $ref: '#/components/schemas/ObjectInformation' GetDataTransferToVaultsSummaryResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/DataTransferToVaultsSummaryResponse' ProtectedObjectsTrendsReportResponse: description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/ProtectionTrend' GetDataTransferFromVaultsSummaryResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/DataTransferFromVaultsSummaryResponse' ProtectionSourcesJobsSummaryReportResponseBodyWrapper: description: Success content: application/json: schema: $ref: '#/components/schemas/ProtectionSourcesJobsSummaryReportResponseWrapper' ProtectionSourcesJobRunsReportResponse: description: Success content: application/json: schema: description: 'Specifies a list of Protection Sources Objects and the Snapshots that contain backups of these Objects.' type: array title: Array of Protection Sources and Snapshots. items: $ref: '#/components/schemas/ProtectionSourcesJobRunsReportElement' ErrorResponse: description: Error content: application/json: schema: $ref: '#/components/schemas/Error' GetReportByIdResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/Report' GetReportsResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/Reports' GetReportPreviewResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/ReportPreview' GetReportTypeAttributesResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/ReportTypeAttributes' ExportReportResponse: description: A PDF or XLS or CSV file content: application/json: schema: type: string format: binary securitySchemes: ApiKeyAuth: type: apiKey in: header name: apiKey x-refined-from: - cohesity-cluster-v1-openapi-original.yml - cohesity-helios-reporting-openapi-original.yml