openapi: 3.2.0 info: description: 'This API list provides operations for interfacing with the Cohesity Cluster.' title: Cohesity REST Audit API version: '1.0' servers: - url: https:///irisservices/api/v1 tags: - name: Audit paths: /public/auditLogs/actions: get: description: A string array of all the actions used to filter audit logs. tags: - Audit summary: Return list of audit log actions operationId: GetAuditLogsActions responses: '200': $ref: '#/components/responses/GetAuditLogsActionsResponse' default: $ref: '#/components/responses/Error' /public/auditLogs/categories: get: description: A string array of all the categories used to filter audit logs. tags: - Audit summary: Return list of audit log categories operationId: GetAuditLogsCategories responses: '200': $ref: '#/components/responses/GetAuditLogsCategoriesResponse' default: $ref: '#/components/responses/Error' /public/auditLogs/cluster: get: description: 'When actions (such as a login or a Job being paused) occur on the Cohesity Cluster, the Cluster generates Audit Logs. If no parameters are specified, all logs currently on the Cohesity Cluster are returned. Specifying the parameters filters the results that are returned.' tags: - Audit summary: Lists the cluster audit logs on the Cohesity Cluster that match the filter… operationId: SearchClusterAuditLogs parameters: - x-go-name: UserNames description: 'Filter by user names who cause the actions that generate Cluster Audit Logs.' name: userNames in: query schema: type: array items: type: string - x-go-name: Domains description: 'Filter by domains of users who cause the actions that trigger Cluster audit logs.' name: domains in: query schema: type: array items: type: string - x-go-name: EntityTypes description: 'Filter by entity types involved in the actions that generate the Cluster audit logs, such as User, Protection Job, View, etc. For a complete list, see the Category drop-down in the Admin > Audit Logs page of the Cohesity Dashboard.' name: entityTypes in: query schema: type: array items: type: string - x-go-name: Actions description: 'Filter by the actions that generate Cluster audit logs such as Activate, Cancel, Clone, Create, etc. For a complete list, see the Actions drop-down in the Admin > Audit Logs page of the Cohesity Dashboard.' name: actions in: query schema: type: array items: type: string - x-go-name: Search description: 'Filter by matching a substring in entity name or details of the Cluster audit log.' name: search in: query schema: type: string - x-go-name: StartTimeUsecs description: 'Filter by a start time. Only Cluster audit logs that were generated 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 specified as a Unix epoch Timestamp (in microseconds). Only Cluster audit logs that were generated before the specified end time are returned.' name: endTimeUsecs in: query schema: type: integer format: int64 - x-go-name: StartIndex description: 'Specifies an index number that can be used to return subsets of items in multiple requests. Break up the items to return into multiple requests by setting pageCount and startIndex to return a subsets of items in the search result. For example, set startIndex to 0 to get the first set of pageCount items for the first request. Increment startIndex by pageCount to get the next set of pageCount items for a next request. Continue until all items are returned and therefore the total number of returned items is equal to totalCount. Default value is 0.' name: startIndex in: query schema: type: integer format: int64 - x-go-name: PageCount description: 'Limit the number of items to return in the response for pagination purposes. Default value is 1000.' name: pageCount in: query schema: type: integer format: int64 - x-go-name: OutputFormat description: 'Specifies the format of the output such as csv and 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: TenantId description: TenantId specifies the tenant whose action resulted in the audit log. name: tenantId in: query schema: type: string - x-go-name: AllUnderHierarchy description: 'AllUnderHierarchy specifies if logs of all the tenants under the hierarchy of tenant with id TenantId should be returned.' name: allUnderHierarchy in: query schema: type: boolean responses: '200': $ref: '#/components/responses/SearchClusterAuditLogsResponse' default: $ref: '#/components/responses/Error' components: responses: GetAuditLogsActionsResponse: description: Success content: application/json: schema: type: array title: List of audit log actions. items: type: string GetAuditLogsCategoriesResponse: description: Success content: application/json: schema: type: array title: List of audit log categories. items: type: string SearchClusterAuditLogsResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/ClusterAuditLogsSearchResult' Error: description: Error content: application/json: schema: $ref: '#/components/schemas/RequestError' schemas: ClusterAuditLogsSearchResult: description: 'Returns the Cluster audit logs that match the specified filter criteria up to the limit specified in pageCount.' type: object title: Cluster Audit Log Filter Result. properties: clusterAuditLogs: description: 'Array of Cluster Audit Logs. Specifies a list of Cluster audit logs that match the specified filter criteria up to the limit specified in pageCount.' type: - array - 'null' items: $ref: '#/components/schemas/ClusterAuditLog' x-go-name: ClusterAuditLogs totalCount: description: 'Specifies the total number of logs that match the specified filter criteria. (This number might be larger than the size of the Cluster Audit Logs array.) This count is provided to indicate if additional requests must be made to get the full result.' type: - integer - 'null' format: int64 x-go-name: TotalCount 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 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 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 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 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 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 Value: description: Specifies a data type and data field used to store data. type: object title: Value. properties: data: $ref: '#/components/schemas/Value_Data' type: description: 'Specifies the type of value. 0 specifies a data point of type Int64. 1 specifies a data point of type Double. 2 specifies a data point of type String. 3 specifies a data point of type Bytes.' type: - integer - 'null' format: int32 x-go-name: Type x-go-package: stats/base/stats_types.pb CassandraAdditionalParams: description: 'Contains additional parameters required by the agents to backup data from Cassandra.' type: object properties: cassandraClasspathSuffix: description: Cassandra classpath suffix. type: - string - 'null' x-go-name: CassandraClasspathSuffix cassandraPartitioner: description: Required in compaction. type: - string - 'null' x-go-name: CassandraPartitioner cassandraVersion: description: 'Cassandra and DSE Versions. Discovery code will attempt to discover the versions.' type: - string - 'null' x-go-name: CassandraVersion dataCenterVec: description: Data center information is required for backup and recovery. type: - array - 'null' items: type: string x-go-name: DataCenterVec dseSolrInfo: description: In case this Cassandra has a Solr node. $ref: '#/components/schemas/DSESolrInfo' dseVersion: type: - string - 'null' x-go-name: DseVersion tieredStorageDirsMap: description: Map of nodes to tiered storage directories type: - array - 'null' items: $ref: '#/components/schemas/NodeToTieredStorageDirectoriesMap' x-go-name: TieredStorageDirsMap x-go-package: magneto/base/nosql.pb Credentials: description: Specifies credentials to access a target source. type: object title: Credentials. properties: password: description: Specifies password of the username to access the target source. type: - string - 'null' x-go-name: Password username: description: Specifies username to access the target source. type: - string - 'null' x-go-name: Username x-go-package: cohesity/iris/server/data/public 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 KeyValuePair: description: Specifies a key/value pair. type: object title: Key Value Pair. properties: key: description: Specifies the name of the key. type: - string - 'null' x-go-name: Key value: description: Specifies a value for the key. $ref: '#/components/schemas/Value' x-go-package: stats/base/stats_types.pb AdditionalOracleDBParams: type: object title: Message to capture additional channel information for Oracle Database. properties: appEntityId: description: Database app id. type: - integer - 'null' format: int64 x-go-name: AppEntityId dbInfoChannelVec: description: 'The following proto message should be renamed to a more general message to represent parameters pertaining to a single unique Oracle database. Uniqueness of an Oracle database should be strictly determined by its database unique name. i.e. all backup parameters needed for a unique Oracle database should be expressed in the following proto. It is a vector for future support of backing up Data Guard sources. We may or may not need this to be vector to support Data Guard sources. For now, the size of this vector is always 1. When we rename this proto in the future, if we determine there is no need to use a vector for Data Guard support, we can choose to remove ''repeated''.' type: - array - 'null' items: $ref: '#/components/schemas/OracleDBChannelInfo' x-go-name: DbInfoChannelVec x-go-package: magneto/base/env_params.pb ClusterConfigProto_SID: description: 'Represents the security identifier that uniquely defines a security principal. SIDs are associated with users and groups. Reference: https://msdn.microsoft.com/en-us/library/aa379597.aspx' type: object properties: identifierAuthority: description: 'The authority under which the SID was created. This is always 6 bytes long.' type: - array - 'null' items: type: integer format: uint8 x-go-name: IdentifierAuthority revisionLevel: description: The revision level of the SID. type: - integer - 'null' format: int32 x-go-name: RevisionLevel subAuthority: description: 'List of ids relative to the identifier_authority that uniquely identify a principal. The last entry in this list is the RID, which uniquely identifies the principal within a domain.' type: - array - 'null' items: type: integer format: uint32 x-go-name: SubAuthority x-go-package: configs/cluster_config.pb 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 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 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 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 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 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 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 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 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 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 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 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 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 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 CouchbaseBackupJobParams: description: 'Contains any additional couchbase environment specific backup params at the job level.' type: object x-go-package: magneto/base/nosql.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 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 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 CommonACLProto: description: 'Protobuf that describes the Common access control list (ACL) permissions for a swift container. TODO (avinash_aita): Verify the ''.rlistings'' write ACL behavior. If necessary, remove persisting ''write_rlistings'' field and fail such requests.' type: object properties: readGrantees: description: Read permissions granted to grantees. $ref: '#/components/schemas/CommonACLProto_Grantees' writeRlistings: description: Write permissions granted to grantees. type: - boolean - 'null' x-go-name: WriteRlistings x-go-package: bridge/s3_portal/base/s3_metadata.pb GranteeProto: type: object title: Message to define a grantee to which ACL permissions can be granted. properties: emailAddress: description: 'If grantee is of type ''kEmailUser'', this field will contain the email address of the user.' type: - string - 'null' x-go-name: EmailAddress group: description: 'If grantee is of type ''kGroup'', this field will contain the group to which permission is granted.' type: - integer - 'null' format: int32 x-go-name: Group type: type: - integer - 'null' format: int32 x-go-name: Type userId: description: 'If grantee is of type ''kRegisteredUser'', this field will contain the canonical id of the user.' type: - string - 'null' x-go-name: UserId x-go-package: bridge/s3_portal/base/s3_metadata.pb 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 VlanParams: type: object title: Contains vlan params associated with the backup/restore operation. properties: disableVlan: description: 'If this is set to true, then even if VLANs are configured on the system, the partition VIPs will be used for the restore.' type: - boolean - 'null' x-go-name: DisableVlan interfaceName: description: 'Interface group to use for restore. If this is not specified, primary interface group for the cluster will be used.' type: - string - 'null' x-go-name: InterfaceName vlanId: description: 'If this is set, then the Cohesity host name or the IP address associated with this vlan is used for mounting Cohesity''s view on the remote host.' type: - integer - 'null' format: int32 x-go-name: VlanId x-go-package: magneto/base/common.pb IdpUserInfo: description: 'Specifies an IdP User''s information logged in using an IdP. This information is not stored on the Cluster.' type: object title: IdP User Information. properties: groups: description: 'Specifies the Idp groups that the user is part of. As the user may not be registered on the cluster, we may have to capture the idp group membership. This way, if a group is created on the cluster later, users will instantly have access to tenantIds from that group as well.' type: - array - 'null' items: type: string x-go-name: Groups idpId: description: Specifies the unique Id assigned by the Cluster for the IdP. type: - integer - 'null' format: int64 x-go-name: IdpId issuerId: description: Specifies the unique identifier assigned by the vendor for this Cluster. type: - string - 'null' x-go-name: IssuerId userId: description: Specifies the unique identifier assigned by the vendor for the user. type: - string - 'null' x-go-name: UserId vendor: description: Specifies the vendor providing the IdP service. type: - string - 'null' x-go-name: Vendor x-go-package: cohesity/iris/server/data/public 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 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 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 RequestError: description: Details about the Error. type: object title: Error properties: errorCode: description: Operation response error code. type: - integer - 'null' format: int64 x-go-name: ErrorCode message: description: Description of the error. type: - string - 'null' x-go-name: Message x-go-package: cohesity/iris/server/data/public KeystoneACLProto_Grantees_ProjectUsers: type: object properties: userIdVec: type: - array - 'null' items: type: string x-go-name: UserIdVec x-go-package: bridge/s3_portal/base/s3_metadata.pb 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 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 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 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 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 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 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 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 User: description: Specifies details about a user. type: object title: User Details. properties: additionalGroupNames: description: 'Array of Additional Groups. Specifies the names of additional groups this User may belong to.' type: - array - 'null' items: type: string x-go-name: AdditionalGroupNames authenticationType: description: 'Specifies the authentication type of the user. ''kAuthLocal'' implies authenticated user is a local user. ''kAuthAd'' implies authenticated user is an Active Directory user. ''kAuthSalesforce'' implies authenticated user is a Salesforce user. ''kAuthGoogle'' implies authenticated user is a Google user. ''kAuthSso'' implies authenticated user is an SSO user.' type: - string - 'null' enum: - kAuthLocal - kAuthAd - kAuthSalesforce - kAuthGoogle - kAuthSso x-go-name: AuthenticationType clusterIdentifiers: description: 'Specifies the list of clusters this user has access to. If this is not specified, access will be granted to all clusters.' type: - array - 'null' items: $ref: '#/components/schemas/ClusterIdentifier' x-go-name: ClusterIdentifiers createdTimeMsecs: description: 'Specifies the epoch time in milliseconds when the user account was created on the Cohesity Cluster.' type: - integer - 'null' format: int64 x-go-name: CreatedTimeMsecs description: description: Specifies a description about the user. type: - string - 'null' x-go-name: Description domain: description: 'Specifies the fully qualified domain name (FQDN) of an Active Directory or LOCAL for the default LOCAL domain on the Cohesity Cluster. A user is uniquely identified by combination of the username and the domain.' type: - string - 'null' x-go-name: Domain effectiveTimeMsecs: description: 'Specifies the epoch time in milliseconds when the user becomes effective. Until that time, the user cannot log in.' type: - integer - 'null' format: int64 x-go-name: EffectiveTimeMsecs emailAddress: description: Specifies the email address of the user. type: - string - 'null' x-go-name: Email expiredTimeMsecs: description: 'Specifies the epoch time in milliseconds when the user becomes expired. After that, the user cannot log in.' type: - integer - 'null' format: int64 x-go-name: ExpiredTimeMsecs forcePasswordChange: description: Specifies whether to force user to change password. type: - boolean - 'null' x-go-name: ForcePasswordChange googleAccount: description: 'Specifies additional information pertaining to Google account. This field is set only for Helios BaaS users who has account on Google.' $ref: '#/components/schemas/GoogleAccountInfo' groupRoles: description: 'Specifies the Cohesity roles to associate with the user'' group. These roles can only be edited from group.' type: - array - 'null' items: type: string x-go-name: GroupRoles readOnly: true idpUserInfo: description: 'Specifies additional information pertaining to an IdP user. This field is set only for IdP users who has logged in via IdP.' $ref: '#/components/schemas/IdpUserInfo' lastUpdatedTimeMsecs: description: 'Specifies the epoch time in milliseconds when the user account was last modified on the Cohesity Cluster.' type: - integer - 'null' format: int64 x-go-name: LastUpdatedTimeMsecs orgMembership: description: 'OrgMembership contains the list of all available tenantIds for this user to switch to. Only when creating the session user, this field is populated on the fly. We discover the tenantIds from various groups assigned to the users.' type: - array - 'null' items: $ref: '#/components/schemas/TenantConfig' x-go-name: OrgMembership password: description: Specifies the password of this user. type: - string - 'null' x-go-name: Password preferences: description: Specifies preferences of the user. $ref: '#/components/schemas/Preferences' primaryGroupName: description: Specifies the name of the primary group of this User. type: - string - 'null' x-go-name: PrimaryGroupName privilegeIds: description: 'Array of Privileges. Specifies the Cohesity privileges from the roles. This will be populated based on the union of all privileges in roles. Type for unique privilege Id values. All below enum values specify a value for all uniquely defined privileges in Cohesity.' type: - array - 'null' items: type: string enum: - kPrincipalView - kPrincipalModify - kAppLaunch - kAppsManagement - kOrganizationView - kOrganizationModify - kOrganizationImpersonate - kCloneView - kCloneModify - kClusterView - kClusterModify - kClusterCreate - kClusterSupport - kClusterUpgrade - kClusterRemoteView - kClusterRemoteModify - kClusterExternalTargetView - kClusterExternalTargetModify - kClusterAudit - kAlertView - kAlertModify - kVlanView - kVlanModify - kHybridExtenderView - kHybridExtenderDownload - kAdLdapView - kAdLdapModify - kSchedulerView - kSchedulerModify - kProtectionView - kProtectionModify - kProtectionJobOperate - kProtectionSourceModify - kProtectionPolicyView - kProtectionPolicyModify - kRestoreView - kRestoreModify - kRestoreDownload - kRemoteRestore - kStorageView - kStorageModify - kStorageDomainView - kStorageDomainModify - kAnalyticsView - kAnalyticsModify - kReportsView - kMcmModify - kDataSecurity - kSmbBackup - kSmbRestore - kSmbTakeOwnership - kSmbAuditing - kMcmUnregister - kMcmUpgrade - kMcmModifySuperAdmin - kMcmViewSuperAdmin - kMcmModifyCohesityAdmin - kMcmViewCohesityAdmin - kObjectSearch - kFileDatalockExpiryTimeDecrease x-go-name: PrivilegeIds restricted: description: 'Whether the user is a restricted user. A restricted user can only view the objects he has permissions to.' type: - boolean - 'null' x-go-name: Restricted roles: description: 'Array of Roles. Specifies the Cohesity roles to associate with the user such as such as ''Admin'', ''Ops'' or ''View''. The Cohesity roles determine privileges on the Cohesity Cluster for this user.' type: - array - 'null' items: type: string x-go-name: Roles s3AccessKeyId: description: Specifies the S3 Account Access Key ID. type: - string - 'null' x-go-name: S3AccessKeyId s3AccountId: description: Specifies the S3 Account Canonical User ID. type: - string - 'null' x-go-name: S3AccountId s3SecretKey: description: Specifies the S3 Account Secret Key. type: - string - 'null' x-go-name: S3SecretKey salesforceAccount: description: 'Specifies additional information pertaining to Salesforce account. This field is set only for Helios users who has account on Salesforce.' $ref: '#/components/schemas/SalesforceAccountInfo' sid: description: 'Specifies the unique Security ID (SID) of the user. This field is mandatory in modifying user.' type: - string - 'null' x-go-name: Sid tenantId: description: Specifies the effective Tenant ID of the user. type: - string - 'null' x-go-name: TenantId username: description: Specifies the login name of the user. type: - string - 'null' x-go-name: Username x-go-package: cohesity/iris/server/data/public SalesforceAccountInfo: description: Salesforce Account Information of a Helios user. type: object title: Salesforce Account Information. properties: accountId: description: Specifies the Account Id assigned by Salesforce. type: - string - 'null' x-go-name: AccountId userId: description: Specifies the User Id assigned by Salesforce. type: - string - 'null' x-go-name: UserId x-go-package: cohesity/iris/server/data/public 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 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 AWSFleetParams_Tag: type: object title: Tag information. properties: key: description: Key for the tag. type: - string - 'null' x-go-name: Key value: description: Value for the tag. type: - string - 'null' x-go-name: Value x-go-package: magneto/base/entities/aws.pb UserInformation: description: 'A message to encapsulate information about the user who made the request. Request should be filtered by these fields if specified so that only the objects that the user is permissioned for are returned. If both sid_vec & tenant_id are specified then an intersection of respective results should be returned.' type: object title: User Information. properties: includeSubtenantObjects: description: 'Whether objects owned by subtenants should be returned. This would require a prefix search with the passed tenant_id. All tenants are considered sub-tenants of the admin. For GET requests, if tenant id is empty(admin user is querying) and if this flag is false, we will only return untagged objects. If it is true, we will return everything.' type: - boolean - 'null' x-go-name: IncludeSubtenantObjects pulseAttributeVec: description: 'Specifies the KeyValuePair that client (eg. Iris) wants to persist along with the corresponding (soon-to-be-created) Pulse task for the current action. Eg. pulse_attribute_vec can drive user notifications by associating a Pulse Task with user SID and later Pulse can be searched by client specified Sid to get all finished tasks for the logged in user.' type: - array - 'null' items: $ref: '#/components/schemas/KeyValuePair' x-go-name: PulseAttributeVec sidVec: description: 'If specified, only the objects associated with these SIDs should be returned.' type: - array - 'null' items: $ref: '#/components/schemas/ClusterConfigProto_SID' x-go-name: SidVec tenantIdVec: description: 'If specified, only the objects associated with this tenant should be returned. A given tenant ID is always a prefix of the ids of its subtenants. Eg. if tenant_id of cluster admin is empty string then it will be a prefix match for all the tenants on the cluster.' type: - array - 'null' items: type: string x-go-name: TenantIdVec x-go-package: magneto/base/permissions.pb 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 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 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 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 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 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 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 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 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 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 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 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 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 DeployDBInstancesToRDSParams: description: 'Contains RDS specfic options that can be supplied while restoring the RDS DB instance.' type: object properties: autoMinorVersionUpgrade: description: Whether to enable auto minor version upgrade in the restored DB. type: - boolean - 'null' x-go-name: AutoMinorVersionUpgrade availabilityZone: description: Entity representing the availability zone to use while restoring the DB. $ref: '#/components/schemas/EntityProto' copyTagsToSnapshots: description: Whether to enable copying of tags to snapshots of the DB. type: - boolean - 'null' x-go-name: CopyTagsToSnapshots dbInstanceId: description: 'The DB instance identifier to use for the restored DB. This field is required.' type: - string - 'null' x-go-name: DbInstanceId dbOptionGroup: description: Entity representing the RDS option group to use while restoring the DB. $ref: '#/components/schemas/EntityProto' dbParameterGroup: description: Entity representing the RDS parameter group to use while restoring the DB. $ref: '#/components/schemas/EntityProto' dbPort: description: Port to use for the DB in the restored RDS instance. type: - integer - 'null' format: int32 x-go-name: DbPort iamDbAuthentication: description: Whether to enable IAM authentication for the DB. type: - boolean - 'null' x-go-name: IamDbAuthentication multiAzDeployment: description: Whether this is a multi-az deployment or not. type: - boolean - 'null' x-go-name: MultiAzDeployment pointInTimeParams: description: If this is set, we will restore DB to the specified point in time. $ref: '#/components/schemas/DeployDBInstancesToRDSParams_PointInTimeRestoreParams' publicAccessibility: description: Whether this DB will be publicly accessible or not. type: - boolean - 'null' x-go-name: PublicAccessibility x-go-package: magneto/base/cloud_deploy.pb ReplicateSnapshotsToAzureParams: description: This is populated for Azure snapshot manager replication. type: object title: Params required to replicate snapshots to another Azure's storage container. properties: resourceGroup: description: Resource group to filter regions in UX. $ref: '#/components/schemas/EntityProto' storageAccount: description: 'Name of the storage account that will contain the storage container within which we will create the blob/snapshot.' $ref: '#/components/schemas/EntityProto' storageContainer: description: Name of the storage container within the above storage account. $ref: '#/components/schemas/EntityProto' storageResourceGroup: description: 'Name of the Azure resource group that has the storage account mentioned below.' $ref: '#/components/schemas/EntityProto' x-go-package: magneto/base/cloud_deploy.pb 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 ViewIdMappingProto_FileLevelDataLockConfig: type: object title: File level data lock configuration. properties: autoLockDurationUsecs: description: 'Auto-lock automatically commit files to WORM state in the filesystem if they have not been modified for an administrator-specified period of time. When the auto-lock is enabled, this field must be set to idle time duration after which file would be automatically locked. Auto locking will be disabled when configured with default value of -1.' type: - integer - 'null' format: int64 x-go-name: AutoLockDurationUsecs defaultRetentionDurationUsecs: description: 'Default retention duration is used when an explicit retention timestamp is not set by user/application when locking a file. If the administrator does not want to enforce this, this field must not be set. If file requires being retained forever by default, this must be set to INT64_MAX. If minimum and maximum retention are enforced, then this must be always between these two durations.' type: - integer - 'null' format: int64 x-go-name: DefaultRetentionDurationUsecs holdTimestampUsecs: description: 'Specifies timestamp to protect locked files until a specific date. This would override retention periods and deny any mutable or remove operations on locked files until a specific date.' type: - integer - 'null' format: int64 x-go-name: HoldTimestampUsecs maxRetentionDurationUsecs: description: 'Specifies maximum retention duration of worm locked file. If the administrator does not want to enforce this, this must not be set. If default and max retention duration are enforced, max retention duration must be greater than or equal to default retention duration. If min and max retention duration are enforced, max retention duration must be greater than and equal to min retention duration.' type: - integer - 'null' format: int64 x-go-name: MaxRetentionDurationUsecs minRetentionDurationUsecs: description: 'Minimum and maximum retention duration allow the administrator to enforce retention duration that falls within a specified range. If the administrator does not want to enforce this, this must not be set. If the file requires being retained forever, this must be set to INT64_MAX. If default retention is enforced, this must be less than or equal to default retention. If max retention are enforced, default retention duration must be less than and equal to max retention duration.' type: - integer - 'null' format: int64 x-go-name: MinRetentionDurationUsecs mode: description: Explicit locking mode. type: - integer - 'null' format: int32 x-go-name: Mode protocol: description: Explicit locking protocol. type: - integer - 'null' format: int32 x-go-name: Protocol x-go-package: bridge/view_keeper/view_metadata.pb AWSFleetParams_NetworkParamsMapEntry: type: object properties: key: type: - string - 'null' x-go-name: Key value: $ref: '#/components/schemas/AWSFleetParams_NetworkParams' x-go-package: magneto/base/entities/aws.pb AzureManagedDiskParams: description: 'Contains managed disk parameters needed to deploy to Azure using managed disk.' type: object properties: dataDisksSkuType: description: SKU type for data disks. type: - integer - 'null' format: int32 x-go-name: DataDisksSkuType osDiskSkuType: description: SKU type for OS disk. type: - integer - 'null' format: int32 x-go-name: OsDiskSkuType x-go-package: magneto/base/cloud_deploy.pb 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 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 OracleVlanInfo: type: object title: Message to capture Cohesity cluster vlan info for Oracle workflow. properties: gateway: description: Gateway for this VLAN. type: - string - 'null' x-go-name: Gateway id: description: ID of this VLAN. type: - integer - 'null' format: int32 x-go-name: Id ipVec: description: List of IPs in this VLAN. type: - array - 'null' items: type: string x-go-name: IpVec subnetIp: description: Subnet IP for this VLAN. type: - string - 'null' x-go-name: SubnetIp x-go-package: magneto/base/env_params.pb CloudDeployTarget: description: 'Message that specifies the details about CloudDeploy target where backup snapshots may be converted and stored.' type: object properties: deployVmsToCloudParams: description: 'Note that only the id field would be set for all the entities in DeployVMsToCloudParams. This is ok as we don''t replicate the policy to remote cluster currently. When we decide to replicate the policy to remote clusters, we need to populate the remaining fields.' title: 'Contains information needed to identify various resources when deploying VMs to Cloud.' $ref: '#/components/schemas/DeployVMsToCloudParams' targetEntity: description: 'Although we use EntityProto here, only the id field would be set in this proto. This is ok as we don''t replicate the policy to remote cluster currently. When we decide to replicate the policy to remote clusters, we need to populate the remaining fields.' title: Entity corresponding to the cloud deploy target. $ref: '#/components/schemas/EntityProto' type: description: The type of the CloudDeploy target. type: - integer - 'null' format: int32 x-go-name: Type x-go-package: magneto/base/policy.pb Links: description: 'The links proto to a specific resource. For example, resource, can be domain, endpoint or service.' type: object properties: next: type: - string - 'null' x-go-name: Next previous: type: - string - 'null' x-go-name: Previous self: type: - string - 'null' x-go-name: Self x-go-package: bridge/s3_portal/keystone/keystone2.pb 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 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