openapi: 3.2.0 info: title: Cohesity Protection Sources API version: '1.0' description: 'Operations tagged ProtectionSources across 2 of this provider''s published API definitions: cohesity-cluster-v1-openapi-original.yml, cohesity-cluster-v2-openapi-original.yml. Each path carries the servers of the definition it was published in.' servers: - url: https:///irisservices/api/v1 - url: /v2 tags: - name: ProtectionSources paths: /public/physicalAgents/download: get: description: Host type could be Linux, Windows, AIX. tags: - ProtectionSources summary: Download the physical agent for a host type operationId: DownloadPhysicalAgent parameters: - x-go-name: HostType description: 'Specifies the host type for which user wants to download the physical agent. ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' name: hostType in: query required: true schema: type: string enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther - x-go-name: LinuxPkgType description: 'Specifies the Linux installer package type applicable only to Linux OS and the value can be any of ("kScript","kRPM", "kSuseRPM", "kDEB") ''kScript'' indicates a script based agent installer. ''kRPM'' indicates a RPM agent installer. ''kSuseRPM'' indicates a Open Suse RPM installer. ''kDEB'' indicates a Debian agent installer.' name: pkgType in: query schema: type: string enum: - kScript - kRPM - kSuseRPM - kDEB - x-go-name: AgentType description: 'Specifies agent type. Can be "kGo" for go agent and "kJava" for java agent and "kCpp" for c++ agent. ''kCpp'' indicates a c++ agent. ''kJava'' indicates a java agent. ''kGo'' indicates a go agent.' name: agentType in: query schema: type: string enum: - kCpp - kJava - kGo responses: '200': $ref: '#/components/responses/DownloadPhysicalAgentResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/physicalAgents/upgrade: post: description: 'If the request is successful, the Cohesity agents on the specified Physical Servers are upgraded to the agent release currently available from this Cohesity Cluster. For example if the Cluster is upgraded from 3.7.1 to 4.0, the agents on the specified Physical Servers can be upgraded to 4.0 using this POST operation. To get the agentIds to pass into this operation, call GET /public/protectionSources with the environment set to ''KPhysical''. In addition this GET operation returns the agentUpgradability field, that indicates if an agent can be upgraded. Use the agentUpgradability field to determine which Physical Servers to upgrade using this POST /public/physicalAgents/upgrade operation. WARNING: Only agents at a particular Cohesity release can be upgraded using this operation. See the Cohesity online help for details. Returns the status of the upgrade initiation.' tags: - ProtectionSources summary: Initiate a request to upgrade Cohesity agents on one or more Physical Servers… operationId: UpgradePhysicalAgents responses: '201': $ref: '#/components/responses/UpgradePhysicalAgentsResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpgradePhysicalServerAgents' description: Request to upgrade agents on Physical Servers. servers: - url: https:///irisservices/api/v1 /public/protectionSources: get: description: 'If no parameters are specified, all Protection Sources that are registered on the Cohesity Cluster are returned. In addition, an Object subtree gathered from each Source is returned. For example, the Cohesity Cluster interrogates a Source VMware vCenter Server and creates an hierarchical Object subtree that mirrors the Inventory tree on vCenter Server. The contents of the Object tree are returned as a "nodes" hierarchy of "protectionSource"s. Specifying parameters can alter the results that are returned.' tags: - ProtectionSources summary: Returns the registered Protection Sources and their Object subtrees operationId: ListProtectionSources parameters: - x-go-name: AfterCursorEntityId description: Specifies the entity id starting from which the items are to be returned. name: afterCursorEntityId in: query schema: type: integer format: int64 - x-go-name: BeforeCursorEntityId description: Specifies the entity id upto which the items are to be returned. name: beforeCursorEntityId in: query schema: type: integer format: int64 - x-go-name: NodeId description: 'Specifies the entity id for the Node at any level within the Source entity hierarchy whose children are to be paginated.' name: nodeId in: query schema: type: integer format: int64 - x-go-name: PageSize description: Specifies the maximum number of entities to be returned within the page. name: pageSize in: query schema: type: integer format: int64 - x-go-name: Id description: Return the Object subtree for the passed in Protection Source id. name: id in: query schema: type: integer format: int64 - x-go-name: NumLevels description: 'Specifies the expected number of levels from the root node to be returned in the entity hierarchy response.' name: numLevels in: query schema: type: integer format: int32 - x-go-name: ExcludeTypes description: 'Filter out the Object types (and their subtrees) that match the passed in types such as ''kVCenter'', ''kFolder'', ''kDatacenter'', ''kComputeResource'', ''kResourcePool'', ''kDatastore'', ''kHostSystem'', ''kVirtualMachine'', etc. For example, set this parameter to ''kResourcePool'' to exclude Resource Pool Objects from being returned.' name: excludeTypes in: query schema: type: array items: enum: - kVCenter - kFolder - kDatacenter - kComputeResource - kClusterComputeResource - kResourcePool - kDatastore - kHostSystem - kVirtualMachine - kVirtualApp - kStandaloneHost - kStoragePod - kNetwork - kDistributedVirtualPortgroup - kTagCategory - kTag type: string - x-go-name: ExcludeOffice365Types description: 'Specifies the Object types to be filtered out for Office 365 that match the passed in types such as ''kDomain'', ''kOutlook'', ''kMailbox'', etc. For example, set this parameter to ''kMailbox'' to exclude Mailbox Objects from being returned.' name: excludeOffice365Types in: query schema: type: array items: enum: - kDomain - kOutlook - kMailbox - kUsers - kUser - kGroups - kGroup - kSites - kSite type: string - x-go-name: ExcludeAwsTypes description: 'Specifies the Object types to be filtered out for AWS that match the passed in types such as ''kEC2Instance'', ''kRDSInstance'' etc. For example, set this parameter to ''kEC2Instance'' to exclude ec2 instance from being returned.' name: excludeAwsTypes in: query schema: type: array items: enum: - kEC2Instance - kRDSInstance type: string - x-go-name: IncludeDatastores description: 'Set this parameter to true to also return kDatastore object types found in the Source in addition to their Object subtrees. By default, datastores are not returned.' name: includeDatastores in: query schema: type: boolean - x-go-name: IncludeNetworks description: 'Set this parameter to true to also return kNetwork object types found in the Source in addition to their Object subtrees. By default, network objects are not returned.' name: includeNetworks in: query schema: type: boolean - x-go-name: IncludeVMFolders description: 'Set this parameter to true to also return kVMFolder object types found in the Source in addition to their Object subtrees. By default, VM folder objects are not returned.' name: includeVMFolders in: query schema: type: boolean - x-go-name: IncludeSystemVApps description: 'Set this parameter to true to also return system VApp object types found in the Source in addition to their Object subtrees. By default, VM folder objects are not returned.' name: includeSystemVApps in: query schema: type: boolean - x-go-name: Environments description: 'Return only Protection Sources that match the passed in environment type such as ''kVMware'', ''kSQL'', ''kView'' ''kPhysical'', ''kPuppeteer'', ''kPure'', ''kNetapp'', ''kGenericNas'', ''kHyperV'', ''kAcropolis'', or ''kAzure''. For example, set this parameter to ''kVMware'' to only return the Sources (and their Object subtrees) found in the ''kVMware'' (VMware vCenter Server) environment. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter.' name: environments in: query schema: type: array items: enum: - kVMware - kSQL - kView - kPuppeteer - kPhysical - kPure - kNetapp - kGenericNas - kHyperV - kAcropolis - kAzure - kKubernetes - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase type: string - x-go-name: Environment description: 'This field is deprecated. Use environments instead. deprecated: true' name: environment in: query schema: type: string - x-go-name: IncludeEntityPermissionInfo description: 'If specified, then a list of entites with permissions assigned to them are returned.' name: includeEntityPermissionInfo in: query schema: type: boolean - x-go-name: Sids description: Filter the object subtree for the sids given in the list. name: sids in: query schema: type: array items: type: string - x-go-name: TenantIds description: 'TenantIds contains ids of the tenants for which objects are to be returned.' name: tenantIds in: query schema: type: array items: type: string - x-go-name: AllUnderHierarchy description: 'AllUnderHierarchy specifies if objects of all the tenants under the hierarchy of the logged in user''s organization should be returned.' name: allUnderHierarchy in: query schema: type: boolean responses: '200': $ref: '#/components/responses/ListProtectionSourcesResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/protectionSources/applicationServers: get: description: 'Given the root node id of a Protection Source tree, returns the list of Application Servers registered under that tree based on the filters.' tags: - ProtectionSources summary: Returns the registered Application Servers and their Object subtrees operationId: ListApplicationServers parameters: - x-go-name: ProtectionSourcesRootNodeId description: 'Specifies the Protection Source Id of the root node of a Protection Sources tree. A root node represents a registered Source on the Cohesity Cluster, such as a vCenter Server.' name: protectionSourcesRootNodeId in: query schema: type: integer format: int64 - x-go-name: Environment description: 'Specifies the environment such as ''kPhysical'' or ''kVMware'' of the Protection Source tree. overrideDescription: true Supported environment types such as ''kView'', ''kSQL'', ''kVMware'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter. ''kVMware'' indicates the VMware Protection Source environment. ''kHyperV'' indicates the HyperV Protection Source environment. ''kSQL'' indicates the SQL Protection Source environment. ''kView'' indicates the View Protection Source environment. ''kPuppeteer'' indicates the Cohesity''s Remote Adapter. ''kPhysical'' indicates the physical Protection Source environment. ''kPure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''kAzure'' indicates the Microsoft''s Azure Protection Source environment. ''kNetapp'' indicates the Netapp Protection Source environment. ''kAgent'' indicates the Agent Protection Source environment. ''kGenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''kAcropolis'' indicates the Acropolis Protection Source environment. ''kPhsicalFiles'' indicates the Physical Files Protection Source environment. ''kIsilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''kGPFS'' indicates IBM''s GPFS Protection Source environment. ''kKVM'' indicates the KVM Protection Source environment. ''kAWS'' indicates the AWS Protection Source environment. ''kExchange'' indicates the Exchange Protection Source environment. ''kHyperVVSS'' indicates the HyperV VSS Protection Source environment. ''kOracle'' indicates the Oracle Protection Source environment. ''kGCP'' indicates the Google Cloud Platform Protection Source environment. ''kFlashBlade'' indicates the Flash Blade Protection Source environment. ''kAWSNative'' indicates the AWS Native Protection Source environment. ''kO365'' indicates the Office 365 Protection Source environment. ''kO365Outlook'' indicates Office 365 outlook Protection Source environment. ''kHyperFlex'' indicates the Hyper Flex Protection Source environment. ''kGCPNative'' indicates the GCP Native Protection Source environment. ''kAzureNative'' indicates the Azure Native Protection Source environment. ''kKubernetes'' indicates a Kubernetes Protection Source environment. ''kElastifile'' indicates Elastifile Protection Source environment. ''kAD'' indicates Active Directory Protection Source environment. ''kRDSSnapshotManager'' indicates AWS RDS Protection Source environment. ''kCassandra'' indicates Cassandra Protection Source environment. ''kMongoDB'' indicates MongoDB Protection Source environment. ''kCouchbase'' indicates Couchbase Protection Source environment. ''kHdfs'' indicates Hdfs Protection Source environment. ''kHive'' indicates Hive Protection Source environment. ''kHBase'' indicates HBase Protection Source environment.' name: environment in: query schema: type: string enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kNimble - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kAzureNative - kKubernetes - kElastifile - kAD - kRDSSnapshotManager - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase - x-go-name: ProtectionSourceId description: 'Specifies the Protection Source Id of the ''kPhysical'' or ''kVMware'' entity in the Protection Source tree hosting the applications.' name: protectionSourceId in: query schema: type: integer format: int64 - x-go-name: Application description: 'Specifies the application such as ''kSQL'', ''kExchange'' running on the Protection Source. overrideDescription: true Supported environment types such as ''kView'', ''kSQL'', ''kVMware'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter. ''kVMware'' indicates the VMware Protection Source environment. ''kHyperV'' indicates the HyperV Protection Source environment. ''kSQL'' indicates the SQL Protection Source environment. ''kView'' indicates the View Protection Source environment. ''kPuppeteer'' indicates the Cohesity''s Remote Adapter. ''kPhysical'' indicates the physical Protection Source environment. ''kPure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''kAzure'' indicates the Microsoft''s Azure Protection Source environment. ''kNetapp'' indicates the Netapp Protection Source environment. ''kAgent'' indicates the Agent Protection Source environment. ''kGenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''kAcropolis'' indicates the Acropolis Protection Source environment. ''kPhsicalFiles'' indicates the Physical Files Protection Source environment. ''kIsilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''kGPFS'' indicates IBM''s GPFS Protection Source environment. ''kKVM'' indicates the KVM Protection Source environment. ''kAWS'' indicates the AWS Protection Source environment. ''kExchange'' indicates the Exchange Protection Source environment. ''kHyperVVSS'' indicates the HyperV VSS Protection Source environment. ''kOracle'' indicates the Oracle Protection Source environment. ''kGCP'' indicates the Google Cloud Platform Protection Source environment. ''kFlashBlade'' indicates the Flash Blade Protection Source environment. ''kAWSNative'' indicates the AWS Native Protection Source environment. ''kO365'' indicates the Office 365 Protection Source environment. ''kO365Outlook'' indicates Office 365 outlook Protection Source environment. ''kHyperFlex'' indicates the Hyper Flex Protection Source environment. ''kGCPNative'' indicates the GCP Native Protection Source environment. ''kAzureNative'' indicates the Azure Native Protection Source environment. ''kKubernetes'' indicates a Kubernetes Protection Source environment. ''kElastifile'' indicates Elastifile Protection Source environment. ''kAD'' indicates Active Directory Protection Source environment. ''kRDSSnapshotManager'' indicates AWS RDS Protection Source environment. ''kCassandra'' indicates Cassandra Protection Source environment. ''kMongoDB'' indicates MongoDB Protection Source environment. ''kCouchbase'' indicates Couchbase Protection Source environment. ''kHdfs'' indicates Hdfs Protection Source environment. ''kHive'' indicates Hive Protection Source environment. ''kHBase'' indicates HBase Protection Source environment.' name: application in: query schema: type: string enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kNimble - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kAzureNative - kKubernetes - kElastifile - kAD - kRDSSnapshotManager - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase responses: '200': $ref: '#/components/responses/ListApplicationServersResponse' default: $ref: '#/components/responses/Error' put: description: 'Returns the Protection Source whose registration parameters of its Application Servers are modified upon success.' tags: - ProtectionSources summary: Modifies the registration parameters of Application Servers in a Protection… operationId: UpdateApplicationServers responses: '200': $ref: '#/components/responses/UpdateApplicationServersResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateApplicationServerParameters' description: 'Request to modify the Application Servers registration of a Protection Source.' required: true post: description: 'Registering Application Servers will help Cohesity Cluster such that any application specific data can be backed up. Returns the Protection Source registered upon success.' tags: - ProtectionSources summary: Register a Protection Source as running one or more Application Servers like… operationId: RegisterApplicationServers responses: '200': $ref: '#/components/responses/RegisterApplicationServersResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterApplicationServersParameters' description: Request to register Application Servers in a Protection Source. required: true servers: - url: https:///irisservices/api/v1 /public/protectionSources/applicationServers/{id}: delete: description: 'Unregistering Application Servers will fail if the Protection Source is currently being backed up. Returns the Protection Source whose Application Servers are unregistered upon success.' tags: - ProtectionSources summary: Unregister Application Servers like Microsoft SQL servers or Microsoft Exchange… operationId: UnregisterApplicationServers parameters: - x-go-name: Id description: 'Specifies a unique id of the Protection Source to unregister the Application Servers. If the Protection Source is currently being backed up, unregister operation will fail.' name: id in: path required: true schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/UnregisterApplicationServersResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/UnRegisterApplicationServersParameters' description: Request to register a protection source. required: true servers: - url: https:///irisservices/api/v1 /public/protectionSources/datastores: get: tags: - ProtectionSources summary: Returns the datastore information in VMware environment operationId: ListDataStoreInformation parameters: - x-go-name: SourceId description: Specifies the id of the virtual machine in vmware environment. name: sourceId in: query required: true schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/ListDataStoreInformationResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/protectionSources/diagnostics/{id}: post: description: 'If the request is successful, the diagnostics script is triggered on Cohesity agent which generates a tarball containing various diagnostics and uploads it to the Cohesity cluster. Host type could be Linux, Windows.' tags: - ProtectionSources summary: Collect diagnostics of the protection source for a host type operationId: RunDiagnostics parameters: - x-go-name: Id description: Specifies the entity id. name: id in: path required: true schema: type: integer format: int64 responses: '201': $ref: '#/components/responses/RunDiagnosticsResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/protectionSources/downloadCftFile: get: tags: - ProtectionSources summary: Download the CFT operationId: DownloadCftFile responses: '200': $ref: '#/components/responses/DownloadCftFileResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/DownloadCftParams' description: Specifies the request to download CFT. servers: - url: https:///irisservices/api/v1 /public/protectionSources/exchangeDagHosts: get: description: 'Returns information about all the exchange hosts that belong to an Exchange DAG.' tags: - ProtectionSources operationId: ListExchangeDagHosts parameters: - x-go-name: Endpoint description: 'Specifies the endpoint of Exchange DAG or a host which is member of Exchange DAG or a standalone exchange server.' name: endpoint in: query schema: type: string - x-go-name: ProtectionSourceId description: Specifies the Protection Source Id of the Exchange DAG source. name: protectionSourceId in: query schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/ListExchangeDagHostsResponse' default: $ref: '#/components/responses/Error' summary: List exchange dag hosts x-summary-source: derived servers: - url: https:///irisservices/api/v1 /public/protectionSources/objects: get: description: Returns the Protection Source objects corresponding to the specified ids. tags: - ProtectionSources summary: List details about Protection Source objects operationId: GetProtectionSourcesObjects parameters: - x-go-name: ObjectIds description: Specifies the ids of the Protection Source objects to return. name: objectIds in: query schema: type: array items: type: integer format: int64 responses: '200': $ref: '#/components/responses/GetProtectionSourcesObjectsResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/protectionSources/objects/{id}: get: description: Returns the Protection Source object corresponding to the specified id. tags: - ProtectionSources summary: Get details about a single Protection Source Object operationId: GetProtectionSourcesObjectById parameters: - x-go-name: Id description: Specifies a unique id of the Protection Source to return. name: id in: path required: true schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/GetProtectionSourcesObjectByIdResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/protectionSources/protectedObjects: get: tags: - ProtectionSources summary: Returns the list of protected Objects in a registered Protection Source operationId: ListProtectedObjects parameters: - x-go-name: Environment description: 'Specifies the environment type of the registered Protection Source such as ''kVMware'', ''kSQL'', ''kView'' ''kPhysical'', ''kPuppeteer'', ''kPure'', ''kNetapp'', ''kGenericNas'', ''kHyperV'', ''kAcropolis'', or ''kAzure''. For example, set this parameter to ''kVMware'' if the registered Protection Source is of ''kVMware'' environment type. Supported environment types such as ''kView'', ''kSQL'', ''kVMware'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter. ''kVMware'' indicates the VMware Protection Source environment. ''kHyperV'' indicates the HyperV Protection Source environment. ''kSQL'' indicates the SQL Protection Source environment. ''kView'' indicates the View Protection Source environment. ''kPuppeteer'' indicates the Cohesity''s Remote Adapter. ''kPhysical'' indicates the physical Protection Source environment. ''kPure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''kAzure'' indicates the Microsoft''s Azure Protection Source environment. ''kNetapp'' indicates the Netapp Protection Source environment. ''kAgent'' indicates the Agent Protection Source environment. ''kGenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''kAcropolis'' indicates the Acropolis Protection Source environment. ''kPhsicalFiles'' indicates the Physical Files Protection Source environment. ''kIsilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''kGPFS'' indicates IBM''s GPFS Protection Source environment. ''kKVM'' indicates the KVM Protection Source environment. ''kAWS'' indicates the AWS Protection Source environment. ''kExchange'' indicates the Exchange Protection Source environment. ''kHyperVVSS'' indicates the HyperV VSS Protection Source environment. ''kOracle'' indicates the Oracle Protection Source environment. ''kGCP'' indicates the Google Cloud Platform Protection Source environment. ''kFlashBlade'' indicates the Flash Blade Protection Source environment. ''kAWSNative'' indicates the AWS Native Protection Source environment. ''kO365'' indicates the Office 365 Protection Source environment. ''kO365Outlook'' indicates Office 365 outlook Protection Source environment. ''kHyperFlex'' indicates the Hyper Flex Protection Source environment. ''kGCPNative'' indicates the GCP Native Protection Source environment. ''kAzureNative'' indicates the Azure Native Protection Source environment. ''kKubernetes'' indicates a Kubernetes Protection Source environment. ''kElastifile'' indicates Elastifile Protection Source environment. ''kAD'' indicates Active Directory Protection Source environment. ''kRDSSnapshotManager'' indicates AWS RDS Protection Source environment. ''kCassandra'' indicates Cassandra Protection Source environment. ''kMongoDB'' indicates MongoDB Protection Source environment. ''kCouchbase'' indicates Couchbase Protection Source environment. ''kHdfs'' indicates Hdfs Protection Source environment. ''kHive'' indicates Hive Protection Source environment. ''kHBase'' indicates HBase Protection Source environment.' name: environment in: query required: true schema: type: string enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kNimble - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kAzureNative - kKubernetes - kElastifile - kAD - kRDSSnapshotManager - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase - x-go-name: Id description: 'Specifies the Id of a registered Protection Source of the type given in environment.' name: id in: query required: true schema: type: integer format: int64 - x-go-name: AllUnderHierarchy description: 'AllUnderHierarchy specifies if objects of all the tenants under the hierarchy of the logged in user''s organization should be returned.' name: allUnderHierarchy in: query schema: type: boolean - x-go-name: IncludeRpoSnapshots description: 'If true, then the Protected Objects protected by RPO policies will also be returned.' name: includeRpoSnapshots in: query schema: type: boolean responses: '200': $ref: '#/components/responses/ListProtectedObjectsResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/protectionSources/refresh/{id}: post: description: 'Force an immediate refresh between the specified Protection Source tree on the Cohesity Cluster and the Inventory tree in the associated vCenter Server. For example if a new VM is added to the vCenter Server, after a refresh, a new Protection Source node for this VM is added to the Protection Sources tree. Success indicates the forced refresh has been completed. For larger sources it is possible for the operation to timeout before the force refresh has been completed. This timeout can be increased by modifying the ''iris_post_timeout_msecs_to_magneto'' gflag on the Iris service.' tags: - ProtectionSources summary: Refresh the Object hierarchy of the Protection Sources tree operationId: RefreshProtectionSourceById parameters: - x-go-name: Id description: 'Id of the root node of the Protection Sources tree to refresh. Force a refresh of the Object hierarchy for the passed in Protection Sources Id.' name: id in: path required: true schema: type: integer format: int64 responses: '204': $ref: '#/components/responses/NoContentResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/protectionSources/register: post: description: 'Register a Protection Source on the Cohesity Cluster. It could be the root node of a vCenter Server or a physical server. Returns the newly registered Protection Source upon success.' tags: - ProtectionSources summary: Register a Protection Source operationId: RegisterProtectionSource responses: '200': $ref: '#/components/responses/RegisterProtectionSourceResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterProtectionSourceParameters' description: Request to register a protection source. required: true servers: - url: https:///irisservices/api/v1 /public/protectionSources/registrationInfo: get: description: 'Returns the registration and protection information of the registered Protection Sources.' tags: - ProtectionSources operationId: ListProtectionSourcesRegistrationInfo parameters: - x-go-name: Environments description: 'Return only Protection Sources that match the passed in environment type such as ''kVMware'', ''kSQL'', ''kView'' ''kPhysical'', ''kPuppeteer'', ''kPure'', ''kNetapp'', ''kGenericNas'', ''kHyperV'', ''kAcropolis'', or ''kAzure''. For example, set this parameter to ''kVMware'' to only return the Sources (and their Object subtrees) found in the ''kVMware'' (VMware vCenter Server) environment. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter.' name: environments in: query schema: type: array items: enum: - kVMware - kSQL - kView - kPuppeteer - kPhysical - kPure - kNetapp - kGenericNas - kHyperV - kAcropolis - kAzure - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kVCD - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kKubernetes - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase type: string - x-go-name: Ids description: Return only the registered root nodes whose Ids are given in the list. name: ids in: query schema: type: array items: type: integer format: int64 - x-go-name: IncludeEntityPermissionInfo description: 'If specified, then a list of entities with permissions assigned to them are returned.' name: includeEntityPermissionInfo in: query schema: type: boolean - x-go-name: Sids description: Filter the registered root nodes for the sids given in the list. name: sids in: query schema: type: array items: type: string - x-go-name: IncludeApplicationsTreeInfo description: Specifies whether to return applications tree info or not. name: includeApplicationsTreeInfo in: query schema: type: boolean - x-go-name: TenantIds description: 'TenantIds contains ids of the tenants for which objects are to be returned.' name: tenantIds in: query schema: type: array items: type: string - x-go-name: AllUnderHierarchy description: 'AllUnderHierarchy specifies if objects of all the tenants under the hierarchy of the logged in user''s organization should be returned.' name: allUnderHierarchy in: query schema: type: boolean responses: '200': $ref: '#/components/responses/ListProtectionSourcesRegistrationInfoResponse' default: $ref: '#/components/responses/Error' summary: List protection sources registration info x-summary-source: derived servers: - url: https:///irisservices/api/v1 /public/protectionSources/rootNodes: get: description: 'Returns the root Protection Sources and the registration information for each of these Sources.' tags: - ProtectionSources summary: Returns the top level (root) Protection Sources with registration information operationId: ListProtectionSourcesRootNodes parameters: - x-go-name: Id description: Return the registration information for the Protection Source id. name: id in: query schema: type: integer format: int64 - x-go-name: Environments description: 'Return only the root Protection Sources that match the passed in environment type such as ''kVMware'', ''kSQL'', ''kView'', ''kPuppeteer'', ''kPhysical'', ''kPure'', ''kNetapp'', ''kGenericNas'', ''kHyperV'', ''kAcropolis'' ''kAzure''. For example, set this parameter to ''kVMware'' to only return the root Protection Sources found in the ''kVMware'' (VMware vCenter) environment. In addition, the registration information for each Source is returned. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter.' name: environments in: query schema: type: array items: enum: - kVMware - kSQL - kView - kPuppeteer - kPhysical - kPure - kNetapp - kGenericNas - kHyperV - kAcropolis - kAzure type: string - x-go-name: Environment description: 'This field is deprecated. Use environments instead. deprecated: true' name: environment in: query schema: type: string responses: '200': $ref: '#/components/responses/ListProtectionSourcesRootNodesResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/protectionSources/sqlAagHostsAndDatabases: get: description: 'Given a list of Protection Source Ids registered as SQL servers, returns AAGs found and the databases in AAG(Always on Availablity Group).' tags: - ProtectionSources summary: Returns the registered Protection Sources and their Object subtrees operationId: ListSqlAagHostsAndDatabases parameters: - x-go-name: SqlProtectionSourceIds description: 'Specifies a list of Ids of Protection Sources registered as SQL servers. These sources may have one or more SQL databases in them. Some of them may be part of AAGs(Always on Availability Group).' name: sqlProtectionSourceIds in: query required: true schema: type: array items: type: integer format: int64 responses: '200': $ref: '#/components/responses/ListSqlAagHostsAndDatabasesResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/protectionSources/virtualMachines: get: description: 'Returns all Virtual Machines found in all the vCenter Servers registered on the Cohesity Cluster that match the filter criteria specified using parameters. If an id is specified, only VMs found in the specified vCenter Server are returned. Only VM Objects are returned. Other VMware Objects such as datacenters are not returned.' tags: - ProtectionSources summary: Returns the Virtual Machines in a vCenter Server operationId: ListVirtualMachines parameters: - x-go-name: VCenterId description: 'Limit the VMs returned to the set of VMs found in a specific vCenter Server. Pass in the root Protection Source id for the vCenter Server to search for VMs.' name: vCenterId in: query schema: type: integer format: int64 - x-go-name: Names description: 'Limit the returned VMs to those that exactly match the passed in VM name. To match multiple VM names, specify multiple "names" parameters that each specify a single VM name. The string must exactly match the passed in VM name and wild cards are not supported.' name: names in: query schema: type: array items: type: string - x-go-name: Uuids description: Limit the returned VMs to those that exactly match the passed in UUIDs. name: uuids in: query schema: type: array items: type: string - x-go-name: Protected description: 'Limit the returned VMs to those that have been protected by a Protection Job. By default, both protected and unprotected VMs are returned.' name: protected in: query schema: type: boolean responses: '200': $ref: '#/components/responses/ListVirtualMachinesResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/protectionSources/{id}: delete: tags: - ProtectionSources summary: Unregister a previously registered Protection Source operationId: UnregisterProtectionSource parameters: - x-go-name: Id description: 'Specifies a unique id of the Protection Source to unregister. If the Protection Source is currently being backed up, unregister operation will fail.' name: id in: path required: true schema: type: integer format: int64 responses: '204': $ref: '#/components/responses/NoContentResponse' default: $ref: '#/components/responses/Error' patch: tags: - ProtectionSources summary: Update a previously registered Protection Source with new details operationId: UpdateProtectionSource parameters: - x-go-name: Id description: Specifies a unique id of the Protection Source to update. name: id in: path required: true schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/UpdatedProtectionSourceResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateProtectionSourceParameters' description: Request to update protection source. servers: - url: https:///irisservices/api/v1 /data-protect/sources: get: description: Get a List of Protection Sources. tags: - ProtectionSources summary: Get a List of Protection Sources operationId: GetProtectionSources parameters: - description: TenantIds contains ids of the tenants for which Sources are to be returned. name: tenantIds in: query schema: type: array items: type: string - description: If true, the response will include Sources which belong belong to all tenants which the current user has permission to see. If false, then only Sources for the current user will be returned. name: includeTenants in: query schema: type: boolean - description: If true, the encrypted crednetial for the registered sources will be included. Credential is first encrypted with internal key and then reencrypted with user supplied encryption key. name: includeSourceCredentials in: query schema: type: boolean - description: Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified. name: encryptionKey in: query schema: type: string responses: '200': $ref: '#/components/responses/SourcesResponse' default: $ref: '#/components/responses/ErrorResponse' security: - APIKeyHeader: [] servers: - url: /v2 /data-protect/sources/filters: get: description: Get a List of attribute filters for leaf entities within a a source tags: - ProtectionSources summary: List attribute filters for a source operationId: GetSourceAttributeFilters parameters: - description: Specifies the source UUID of the parent entity. name: sourceUuid in: query required: true schema: type: string - description: Specifies the environment type of the Protection Source. name: environment in: query schema: type: string enum: - kVMware - kHyperV - kAcropolis - kKVM - kAWS - kGCP - kAzure - kPhysical - kPure - kNimble - kNetapp - kGenericNas - kIsilon - kFlashBlade - kGPFS - kElastifile - kO365 - kHyperFlex - kKubernetes - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase - kUDA responses: '200': $ref: '#/components/responses/SourceAttributeFiltersResponse' default: $ref: '#/components/responses/ErrorResponse' security: - APIKeyHeader: [] servers: - url: /v2 /data-protect/sources/registrations: get: description: Get the list of Protection Source registrations. tags: - ProtectionSources summary: Get the list of Protection Source registrations operationId: GetSourceRegistrations parameters: - description: Ids specifies the list of source registration ids to return. If left empty, every source registration will be returned by default. name: ids in: query schema: type: array items: type: integer - description: TenantIds contains ids of the tenants for which objects are to be returned. name: tenantIds in: query schema: type: array items: type: string - description: If true, the response will include Registrations which were created by all tenants which the current user has permission to see. If false, then only Registrations created by the current user will be returned. name: includeTenants in: query schema: type: boolean - description: If true, the encrypted crednetial for the registered sources will be included. Credential is first encrypted with internal key and then reencrypted with user supplied encryption key. name: includeSourceCredentials in: query schema: type: boolean - description: Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified. name: encryptionKey in: query schema: type: string responses: '200': $ref: '#/components/responses/SourceRegistrationsResponse' default: $ref: '#/components/responses/ErrorResponse' security: - APIKeyHeader: [] post: description: Register a Protection Source. tags: - ProtectionSources summary: Register a Protection Source operationId: postDataProtectSourcesRegistrations responses: '201': $ref: '#/components/responses/SourceRegistrationResponse' default: $ref: '#/components/responses/ErrorResponse' security: - APIKeyHeader: [] requestBody: content: application/json: schema: x-cohesity-discriminator-ref: CommonSourceRegistrationRequestParams $ref: '#/components/schemas/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4' description: Specifies the parameters to register a Protection Source. required: true x-operation-id-source: normalized x-operation-id-original: RegisterProtectionSource servers: - url: /v2 /data-protect/sources/registrations/{id}: get: description: Get a Protection Source registration. tags: - ProtectionSources summary: Get a Protection Source registration operationId: GetProtectionSourceRegistration parameters: - description: Specifies the id of the Protection Source registration. name: id in: path required: true schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/SourceRegistrationResponse' default: $ref: '#/components/responses/ErrorResponse' security: - APIKeyHeader: [] put: description: Update Protection Source registration. tags: - ProtectionSources summary: Update Protection Source registration operationId: UpdateProtectionSourceRegistration parameters: - description: Specifies the id of the Protection Source registration. name: id in: path required: true schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/SourceRegistrationResponse' default: $ref: '#/components/responses/ErrorResponse' security: - APIKeyHeader: [] requestBody: content: application/json: schema: x-cohesity-discriminator-ref: CommonSourceRegistrationRequestParams $ref: '#/components/schemas/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4' description: Specifies the parameters to update the registration. required: true delete: description: Delete Protection Source Registration. tags: - ProtectionSources summary: Delete Protection Source Registration operationId: DeleteProtectionSourceRegistration parameters: - description: Specifies the ID of the Protection Source Registration. name: id in: path required: true schema: type: integer format: int64 responses: '204': $ref: '#/components/responses/NoContentResponse' default: $ref: '#/components/responses/ErrorResponse' security: - APIKeyHeader: [] servers: - url: /v2 /data-protect/sources/test-connection: post: description: Test connection to a source. tags: - ProtectionSources summary: Test connection to a source operationId: TestConnectionProtectionSource responses: '200': $ref: '#/components/responses/SourceConnectionResponse' default: $ref: '#/components/responses/ErrorResponse' security: - APIKeyHeader: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/SourceConnectionRequestParams' description: Specifies the parameters to test connectivity with a source. required: true servers: - url: /v2 /data-protect/sources/virtual-datacenter/{id}: get: description: Get the details such as catelogs, Org networks associated with a VMware virtual datacenter (VDC). tags: - ProtectionSources summary: Get VDC Details operationId: GetVdcDetails parameters: - description: Specifies the ID of the VMware virtual datacenter. name: id in: path required: true schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/GetVdcByIdResponse' default: $ref: '#/components/responses/ErrorResponse' security: - APIKeyHeader: [] servers: - url: /v2 /data-protect/sources/{id}: get: description: Get a Protection Source. tags: - ProtectionSources summary: Get a Protection Sources operationId: ProtectionSourceById parameters: - description: Specifies the id of the Protection Source. name: id in: path required: true schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/SourceResponse' default: $ref: '#/components/responses/ErrorResponse' security: - APIKeyHeader: [] servers: - url: /v2 components: schemas: DownloadCftResponse: type: object title: CFT/Json file response. properties: content: description: Specifies the content of the file. type: - array - 'null' items: type: integer format: uint8 x-go-name: Content fileName: description: 'Specifies the content of the CFT. in: body Specifies the file name of the cloud formation template.' type: - string - 'null' x-go-name: FileName x-go-package: cohesity/iris/server/data/public PhysicalSpecialParameters: description: 'Specifies additional special settings applicable for a Protection Source of ''kPhysical'' type in a Protection Job.' type: object title: Physical Source Special Job Parameters. properties: applicationParameters: description: 'Specifies parameters that are related to applications running on the Protection Source.' $ref: '#/components/schemas/ApplicationParameters' enableSystemBackup: description: 'Specifies whether to allow system backup using 3rd party tools installed on the Protection Host. System backups are used for doing bare metal recovery later. This field is applicable only for System backups.' type: - boolean - 'null' x-go-name: EnableSystemBackup filePaths: description: 'Array of File Paths to Back Up. Specifies a list of directories or files to protect in a Physical Server.' type: - array - 'null' items: $ref: '#/components/schemas/FilePathParameters' x-go-name: FilePaths metadataFilePath: description: 'Specifies metadata path on source. This file contains absolute paths of files that needs to be backed up on the same source.' type: - string - 'null' x-go-name: MetadataFilePath skipNestedVolumesVec: description: Specifies mounttypes of nested volumes to be skipped. type: - array - 'null' items: type: string x-go-name: SkipNestedVolumesVec usesSkipNestedVolumesVec: description: Specifies whether to use SkipNestedVolumes vec to skip nested mounts. type: - boolean - 'null' x-go-name: UsesSkipNestedVolumesVec volumeGuid: description: 'Array of Mounted Volumes to Back Up. Specifies the subset of mounted volumes to protect in a Physical Server. If not specified, all mounted volumes on a Physical Server are protected.' type: - array - 'null' items: type: string x-go-name: VolumeGuid windowsParameters: description: Specifies parameters applicable only to Windows hosts. $ref: '#/components/schemas/WindowsHostSnapshotParameters' x-go-package: cohesity/iris/server/data/public VlanParameters: description: Specifies VLAN parameters for the restore operation. type: object title: VLAN Parameters. properties: disableVlan: description: 'Specifies whether to use the VIPs even when VLANs are configured on the Cluster. If configured, VLAN IP addresses are used by default. If VLANs are not configured, this flag is ignored. Set this flag to true to force using the partition VIPs when VLANs are configured on the Cluster.' type: - boolean - 'null' x-go-name: DisableVlan interfaceName: description: 'Specifies the physical interface group name to use for mounting Cohesity''s view on the remote host. If specified, Cohesity hostname or the IP address on this VLAN is used.' type: - string - 'null' x-go-name: InterfaceName vlan: description: 'Specifies the VLAN to use for mounting Cohesity''s view on the remote host. If specified, Cohesity hostname or the IP address on this VLAN is used.' type: - integer - 'null' format: int32 x-go-name: Vlan x-go-package: cohesity/iris/server/data/public PaginationParameters: description: 'Specifies the cursor based pagination parameters for Protection Source and its children. Pagination is supported at a given level within the Protection Source Hierarchy with the help of before or after cursors. A Cursor will always refer to a specific source within the source dataset but will be invalidated if the item is removed.' type: object properties: afterCursorEntityId: description: Specifies the entity id starting from which the items are to be returned. type: - integer - 'null' format: int64 x-go-name: AfterCursorEntityId beforeCursorEntityId: description: Specifies the entity id upto which the items are to be returned. type: - integer - 'null' format: int64 x-go-name: BeforeCursorEntityId nodeId: description: 'Specifies the entity id for the Node at any level within the Source entity hierarchy whose children are to be paginated.' type: - integer - 'null' format: int64 x-go-name: NodeId pageSize: description: Specifies the maximum number of entities to be returned within the page. type: - integer - 'null' format: int64 x-go-name: PageSize x-go-package: cohesity/iris/server/data/public AzureProtectionSource: description: Specifies a Protection Source in Azure environment. type: object title: Azure Protection Source. properties: applicationId: description: Specifies Application Id of the active directory of Azure account. type: - string - 'null' x-go-name: ApplicationId applicationKey: description: Specifies Application key of the active directory of Azure account. type: - string - 'null' x-go-name: ApplicationKey azureType: description: 'Specifies the entity type such as ''kSubscription'' if the environment is kAzure. Specifies the type of an Azure source entity. ''kSubscription'' indicates a billing unit within Azure account. ''kResourceGroup'' indicates a container that holds related resources. ''kVirtualMachine'' indicates a Virtual Machine in Azure environment. ''kStorageAccount'' represents a collection of storage containers. ''kStorageKey'' indicates a key required to access the storage account. ''kStorageContainer'' represents a storage container within a storage account. ''kStorageBlob'' represents a storage blog within a storage container. ''kStorageResourceGroup'' indicates a container that holds related storage resources. ''kNetworkSecurityGroup'' represents a network security group. ''kVirtualNetwork'' represents a virtual network. ''kNetworkResourceGroup'' indicates a container that holds related network resources. ''kSubnet'' represents a subnet within the virtual network. ''kComputeOptions'' indicates the number of CPU cores and memory size available for a type of a Virtual Machine.' type: - string - 'null' enum: - kSubscription - kResourceGroup - kVirtualMachine - kStorageAccount - kStorageKey - kStorageContainer - kStorageBlob - kStorageResourceGroup - kNetworkSecurityGroup - kVirtualNetwork - kNetworkResourceGroup - kSubnet - kComputeOptions x-go-name: AzureType hostType: description: 'Specifies the OS type of the Protection Source of type ''kVirtualMachine'' such as ''kWindows'' or ''kLinux''. overrideDescription: true ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: HostType ipAddresses: description: Specifies a list of IP addresses for entities of type 'kVirtualMachine'. type: - array - 'null' items: type: string x-go-name: IpAddresses isManagedVm: description: 'Specifies whether VM is managed or not for entities of type ''kVirtualMachine''.' type: - boolean - 'null' x-go-name: IsManagedVm location: description: Specifies the physical location of the resource group. type: - string - 'null' x-go-name: Location memoryMbytes: description: 'Specifies the amount of memory in MegaBytes of the Azure resource of type ''kComputeOptions''.' type: - integer - 'null' format: int64 x-go-name: MemoryMbytes name: description: 'Specifies the name of the Object set by the Cloud Provider. If the provider did not set a name for the object, this field is not set.' type: - string - 'null' x-go-name: Name numCores: description: 'Specifies the number of CPU cores of the Azure resource of type ''kComputeOptions''.' type: - integer - 'null' format: int32 x-go-name: NumCores physicalSourceId: description: 'Specifies the Protection Source id of the registered Physical Host. If the cloud entity is protected using a Physical Agent, it must be registered as a physical host.' type: - integer - 'null' format: int64 x-go-name: PhysicalSourceId resourceId: description: Specifies the unique Id of the resource given by the cloud provider. type: - string - 'null' x-go-name: ResourceId restoreTaskId: description: 'Specifies the id of the "convert and deploy" restore task that created the entity in the cloud. It is required to support the DR-to-cloud usecase where we replicate an on-prem entity to a cluster running in cloud, bring it up using "convert and deploy" mechanism, protect it using a cloud job that uses physical adapter, and convert it back to the on-prem format before replication. Before replicating, we need to update the backup task state of the backed up entity using the on-prem entity and on-prem entity''s parent. The id is used to lookup the restore entity that contains details about the on-prem entity. It is set at the time of refreshing the cloud entity hierarchy if all the following conditions are met: Name of the current entity matches with name of any cloud entity deployed using the "convert and deploy" restore task. Restore entity associated with the above matched cloud entity has ''failed_over'' flag set to true in its cloud extension.' type: - integer - 'null' format: int64 x-go-name: RestoreTaskId subscriptionId: description: 'Specifies Subscription id inside a customer''s Azure account. It represents sub-section within the Azure account where a customer allows us to create VMs, storage account etc.' type: - string - 'null' x-go-name: SubscriptionId subscriptionType: description: 'Specifies the subscription type of Azure such as ''kAzureCommercial'' or ''kAzureGovCloud''. Specifies the subscription type of an Azure source entity. ''kAzureCommercial'' indicates a standard Azure subscription. ''kAzureGovCloud'' indicates a govt Azure subscription.' type: - string - 'null' enum: - kAzureCommercial - kAzureGovCloud x-go-name: SubscriptionType tenantId: description: Specifies Tenant Id of the active directory of Azure account. type: - string - 'null' x-go-name: TenantId type: description: 'Specifies the type of an Azure Protection Source Object such as ''kStorageContainer'', ''kVirtualMachine'', ''kVirtualNetwork'', etc. Specifies the type of an Azure source entity. ''kSubscription'' indicates a billing unit within Azure account. ''kResourceGroup'' indicates a container that holds related resources. ''kVirtualMachine'' indicates a Virtual Machine in Azure environment. ''kStorageAccount'' represents a collection of storage containers. ''kStorageKey'' indicates a key required to access the storage account. ''kStorageContainer'' represents a storage container within a storage account. ''kStorageBlob'' represents a storage blog within a storage container. ''kStorageResourceGroup'' indicates a container that holds related storage resources. ''kNetworkSecurityGroup'' represents a network security group. ''kVirtualNetwork'' represents a virtual network. ''kNetworkResourceGroup'' indicates a container that holds related network resources. ''kSubnet'' represents a subnet within the virtual network. ''kComputeOptions'' indicates the number of CPU cores and memory size available for a type of a Virtual Machine.' type: - string - 'null' enum: - kSubscription - kResourceGroup - kVirtualMachine - kStorageAccount - kStorageKey - kStorageContainer - kStorageBlob - kStorageResourceGroup - kNetworkSecurityGroup - kVirtualNetwork - kNetworkResourceGroup - kSubnet - kComputeOptions x-go-name: Type x-go-package: cohesity/iris/server/data/public EntityPermissionInformation: description: Specifies the permission information of entities. type: object title: Entity Permission Information. properties: entityId: description: Specifies the entity id. type: - integer - 'null' format: int64 x-go-name: EntityId groups: description: Specifies groups that have access to entity in case of restricted user. type: - array - 'null' items: $ref: '#/components/schemas/GroupInfo' x-go-name: Groups isInferred: description: 'Specifies whether the Entity Permission Information is inferred or not. For example, SQL application hosted over vCenter will have inferred entity permission information.' type: - boolean - 'null' x-go-name: IsInferred tenant: description: Specifies basic information of the tenant having access to the entity. $ref: '#/components/schemas/TenantInfo' users: description: Specifies users that have access to entity in case of restricted user. type: - array - 'null' items: $ref: '#/components/schemas/UserInfo' x-go-name: Users x-go-package: cohesity/iris/server/data/public PhysicalProtectionSource: description: Specifies a Protection Source in a Physical environment. type: object title: Physical Protection Source. properties: agents: description: 'Array of Agents on the Physical Protection Source. Specifiles the agents running on the Physical Protection Source and the status information.' type: - array - 'null' items: $ref: '#/components/schemas/AgentInformation' x-go-name: Agents hostName: description: Specifies the hostname. type: - string - 'null' x-go-name: HostName hostType: description: 'Specifies the environment type for the host. ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: HostType id: description: 'Specifies a unique id of a Physical Protection Source. The id is unique across Cohesity Clusters.' allOf: - $ref: '#/components/schemas/UniversalId' memorySizeBytes: description: Specifies the total memory on the host in bytes. type: - integer - 'null' format: int64 x-go-name: MemorySizeBytes name: description: Specifies a human readable name of the Protection Source. type: - string - 'null' x-go-name: Name networkingInfo: description: 'Cached networking info. This establishes physical-->agent linkage for the Cluster case.' $ref: '#/components/schemas/NetworkingInformation' numProcessors: description: Specifies the number of processors on the host. type: - integer - 'null' format: int64 x-go-name: NumProcessors osName: description: Specifies a human readable name of the OS of the Protection Source. type: - string - 'null' x-go-name: OsName type: description: 'Specifies the type of managed Object in a Physical Protection Source. ''kGroup'' indicates the EH container. ''kHost'' indicates a single physical server. ''kWindowsCluster'' indicates a Microsoft Windows cluster. ''kOracleRACCluster'' indicates an Oracle Real Application Cluster(RAC). ''kOracleAPCluster'' indicates an Oracle Active-Passive Cluster.' type: - string - 'null' enum: - kGroup - kHost - kWindowsCluster - kOracleRACCluster - kOracleAPCluster x-go-name: Type vcsVersion: description: Specifies cluster version for VCS host. type: - string - 'null' x-go-name: VcsVersion volumes: description: 'Array of Physical Volumes. Specifies the volumes available on the physical host. These fields are populated only for the kPhysicalHost type.' type: - array - 'null' items: $ref: '#/components/schemas/PhysicalVolume' x-go-name: Volumes x-go-package: cohesity/iris/server/data/public 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 UniversalId: description: 'Specifies an id for an object that is unique across Cohesity Clusters. The id is composite of all the ids listed below.' type: object title: Unique Global Id. properties: clusterId: description: Specifies the Cohesity Cluster id where the object was created. type: - integer - 'null' format: int64 x-go-name: ClusterId clusterIncarnationId: description: 'Specifies an id for the Cohesity Cluster that is generated when a Cohesity Cluster is initially created.' type: - integer - 'null' format: int64 x-go-name: ClusterIncarnationId id: description: 'Specifies a unique id assigned to an object (such as a Job) by the Cohesity Cluster.' type: - integer - 'null' format: int64 x-go-name: Id x-go-package: cohesity/iris/server/data/public KubernetesCredentials: description: Specifies the credentials to authenticate with a Kubernetes Cluster. type: object title: Kubernetes Credentials. properties: clientPrivateKey: description: Specifies Client private associated with the service account. type: - string - 'null' x-go-name: ClientPrivateKey x-go-package: cohesity/iris/server/data/public CouchbaseCluster: description: Specifies an Object containing information about a couchbase cluster. type: object title: Couchbase Cluster Info. properties: seeds: description: Seeds of this Couchbase Cluster. type: - array - 'null' items: type: string x-go-name: Seeds x-go-package: cohesity/iris/server/data/public SchedulingPolicy: description: Specifies settings that define a backup schedule for a Protection Job. type: object title: Scheduling Policy. properties: continuousSchedule: description: 'Specifies the time interval between two Job Runs of a continuous backup schedule and any blackout periods when new Job Runs should NOT be started. Set if periodicity is kContinuous.' allOf: - $ref: '#/components/schemas/ContinuousSchedule' dailySchedule: description: 'Specifies a daily or weekly backup schedule. Set if periodicity is kDaily.' allOf: - $ref: '#/components/schemas/DailySchedule' monthlySchedule: description: 'Specifies a monthly backup schedule. Set if periodicity is kMonthly.' allOf: - $ref: '#/components/schemas/MonthlySchedule' periodicity: description: 'Specifies how often to start new Job Runs of a Protection Job. ''kDaily'' means new Job Runs start daily. ''kMonthly'' means new Job Runs start monthly. ''kContinuous'' means new Job Runs repetitively start at the beginning of the specified time interval (in hours or minutes). ''kContinuousRPO'' means this is an RPO schedule.' type: - string - 'null' enum: - kContinuous - kDaily - kMonthly - kContinuousRPO x-go-name: Periodicity rpoSchedule: description: 'Specifies an RPO backup schedule. Set if periodicity is kContinuousRPO.' allOf: - $ref: '#/components/schemas/RpoSchedule' x-go-package: cohesity/iris/server/data/public ProtectionSourceNode: description: 'Many different node types are supported such as ''kComputeResource'' and ''kResourcePool''.' type: object title: Node in a Protection Sources Tree. properties: applicationNodes: description: 'Array of Child Subtrees. Specifies the child subtree used to store additional application-level Objects. Different environments use the subtree to store application-level information. For example for SQL Server, this subtree stores the SQL Server instances running on a VM.' type: - array - 'null' items: description: 'Many different node types are supported such as ''kComputeResource'' and ''kResourcePool''.' type: object title: Node in a Protection Sources Tree. (ProtectionSourceNode) x-go-name: ApplicationNodes entityPaginationParameters: description: 'Specifies the cursor based pagination parameters for Protection Source to fetch the next set of sources within a level. This parameter will only be present at the parent entity.' $ref: '#/components/schemas/PaginationParameters' entityPermissionInfo: description: Specifies permission information for the entities. $ref: '#/components/schemas/EntityPermissionInformation' logicalSize: description: 'Specifies the logical size of the data in bytes for the Object on this node. Presence of this field indicates this node is a leaf node.' type: - integer - 'null' format: int64 x-go-name: LogicalSize nodes: description: 'Array of Child Nodes. Specifies children of the current node in the Protection Sources hierarchy. When representing Objects in memory, the entire Object subtree hierarchy is represented. You can use this subtree to navigate down the Object hierarchy.' type: - array - 'null' items: description: 'Many different node types are supported such as ''kComputeResource'' and ''kResourcePool''.' type: object title: Node in a Protection Sources Tree. (ProtectionSourceNode) x-go-name: Nodes protectedSourcesSummary: description: 'Array of Protected Objects. Specifies aggregated information about all the child Objects of this node that are currently protected by a Protection Job. There is one entry for each environment that is being backed up. The aggregated information for the Object hierarchy''s environment will be available at the 0th index of the vector.' type: - array - 'null' items: $ref: '#/components/schemas/AggregatedSubtreeInfo' x-go-name: ProtectedSourcesSummary protectionSource: description: Specifies the Protection Source for the current node. allOf: - $ref: '#/components/schemas/ProtectionSource' registrationInfo: description: 'Specifies registration information for a root node in a Protection Sources tree. A root node represents a registered Source on the Cohesity Cluster, such as a vCenter Server.' allOf: - $ref: '#/components/schemas/RegisteredSourceInfo' unprotectedSourcesSummary: description: 'Array of Unprotected Sources. Specifies aggregated information about all the child Objects of this node that are not protected by any Protection Jobs. The aggregated information for the Objects hierarchy''s environment will be available at the 0th index of the vector. NOTE: This list includes Objects that were protected at some point in the past but are no longer actively protected. Snapshots containing these Objects may even exist on the Cohesity Cluster and be available to recover from.' type: - array - 'null' items: $ref: '#/components/schemas/AggregatedSubtreeInfo' x-go-name: UnprotectedSourcesSummary x-go-package: cohesity/iris/server/data/public BackupRun: description: 'Specifies details about the Backup task for a Job Run. A Backup task captures the original backup snapshots for each Protection Source in the Job.' type: object title: Backup Run Task. properties: environment: description: 'Specifies the environment type that the task is protecting. Supported environment types such as ''kView'', ''kSQL'', ''kVMware'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter. ''kVMware'' indicates the VMware Protection Source environment. ''kHyperV'' indicates the HyperV Protection Source environment. ''kSQL'' indicates the SQL Protection Source environment. ''kView'' indicates the View Protection Source environment. ''kPuppeteer'' indicates the Cohesity''s Remote Adapter. ''kPhysical'' indicates the physical Protection Source environment. ''kPure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''kAzure'' indicates the Microsoft''s Azure Protection Source environment. ''kNetapp'' indicates the Netapp Protection Source environment. ''kAgent'' indicates the Agent Protection Source environment. ''kGenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''kAcropolis'' indicates the Acropolis Protection Source environment. ''kPhsicalFiles'' indicates the Physical Files Protection Source environment. ''kIsilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''kGPFS'' indicates IBM''s GPFS Protection Source environment. ''kKVM'' indicates the KVM Protection Source environment. ''kAWS'' indicates the AWS Protection Source environment. ''kExchange'' indicates the Exchange Protection Source environment. ''kHyperVVSS'' indicates the HyperV VSS Protection Source environment. ''kOracle'' indicates the Oracle Protection Source environment. ''kGCP'' indicates the Google Cloud Platform Protection Source environment. ''kFlashBlade'' indicates the Flash Blade Protection Source environment. ''kAWSNative'' indicates the AWS Native Protection Source environment. ''kO365'' indicates the Office 365 Protection Source environment. ''kO365Outlook'' indicates Office 365 outlook Protection Source environment. ''kHyperFlex'' indicates the Hyper Flex Protection Source environment. ''kGCPNative'' indicates the GCP Native Protection Source environment. ''kAzureNative'' indicates the Azure Native Protection Source environment. ''kKubernetes'' indicates a Kubernetes Protection Source environment. ''kElastifile'' indicates Elastifile Protection Source environment. ''kAD'' indicates Active Directory Protection Source environment. ''kRDSSnapshotManager'' indicates AWS RDS Protection Source environment. ''kCassandra'' indicates Cassandra Protection Source environment. ''kMongoDB'' indicates MongoDB Protection Source environment. ''kCouchbase'' indicates Couchbase Protection Source environment. ''kHdfs'' indicates Hdfs Protection Source environment. ''kHive'' indicates Hive Protection Source environment. ''kHBase'' indicates HBase Protection Source environment.' type: - string - 'null' enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kNimble - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kAzureNative - kKubernetes - kElastifile - kAD - kRDSSnapshotManager - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase x-go-name: Environment error: description: 'Specifies if an error occurred (if any) while running this task. This field is populated when the status is equal to ''kFailure''.' type: - string - 'null' x-go-name: Error jobRunId: description: 'Specifies the id of the Job Run that ran the backup task and the copy tasks.' type: - integer - 'null' format: int64 x-go-name: JobRunId message: description: 'Specifies a message after finishing the task successfully. This field is optionally populated when the status is equal to ''kSuccess''.' type: - string - 'null' x-go-name: Message metadataDeleted: description: 'Specifies if the metadata and snapshots associated with this Job Run have been deleted. This field is set to true when the snapshots, which are marked for deletion, are removed by garbage collection. The associated metadata is also deleted.' type: - boolean - 'null' x-go-name: MetadataDeleted quiesced: description: 'Specifies if app-consistent snapshot was captured. This field is set to true, if an app-consistent snapshot was taken by quiescing applications and the file system before taking a backup.' type: - boolean - 'null' x-go-name: Quiesced runType: description: 'Specifies the type of backup such as ''kRegular'', ''kFull'', ''kLog'' or ''kSystem''. ''kRegular'' indicates a incremental (CBT) backup. Incremental backups utilizing CBT (if supported) are captured of the target protection objects. The first run of a kRegular schedule captures all the blocks. ''kFull'' indicates a full (no CBT) backup. A complete backup (all blocks) of the target protection objects are always captured and Change Block Tracking (CBT) is not utilized. ''kLog'' indicates a Database Log backup. Capture the database transaction logs to allow rolling back to a specific point in time. ''kSystem'' indicates a system backup. System backups are used to do bare metal recovery of the system to a specific point in time.' type: - string - 'null' enum: - kRegular - kFull - kLog - kSystem x-go-name: RunType slaViolated: description: 'Specifies if the SLA was violated for the Job Run. This field is set to true, if time to complete the Job Run is longer than the SLA specified. This field is populated when the status is set to ''kSuccess'' or ''kFailure''.' type: - boolean - 'null' x-go-name: SlaViolated snapshotsDeleted: description: 'Specifies if backup snapshots associated with this Job Run have been marked for deletion because of the retention settings in the Policy or if they were manually deleted from the Cohesity Dashboard.' type: - boolean - 'null' x-go-name: SnapshotsDeleted snapshotsDeletedTimeUsecs: description: 'Specifies if backup snapshots associated with this Job Run have been marked for deletion because of the retention settings in the Policy or if they were manually deleted from the Cohesity Dashboard.' type: - integer - 'null' format: int64 x-go-name: SnapshotsDeletedTimeUsecs sourceBackupStatus: description: 'Array of Source Object Backup Status. Specifies the status of backing up each source objects (such as VMs) associated with the job.' type: - array - 'null' items: $ref: '#/components/schemas/SourceBackupStatus' x-go-name: SourceBackupStatus stats: description: 'Specifies the aggregated stats of all Backup Run tasks in a Protection Run.' $ref: '#/components/schemas/ProtectionJobRunStats' status: description: 'Specifies the status of Backup task such as ''kRunning'', ''kSuccess'', ''kFailure'' etc. ''kAccepted'' indicates the task is queued to run but not yet running. ''kRunning'' indicates the task is running. ''kCanceling'' indicates a request to cancel the task has occurred but the task is not yet canceled. ''kCanceled'' indicates the task has been canceled. ''kSuccess'' indicates the task was successful. ''kFailure'' indicates the task failed. ''kWarning'' indicates the task has finished with warning. ''kOnHold'' indicates the task is kept onHold. ''kMissed'' indicates the task is missed.' type: - string - 'null' enum: - kAccepted - kRunning - kCanceling - kCanceled - kSuccess - kFailure - kWarning - kOnHold - kMissed x-go-name: Status warnings: description: 'Array of Warnings. Specifies the warnings that occurred (if any) while running this task.' type: - array - 'null' items: type: string x-go-name: Warnings wormRetentionType: description: 'Specifies WORM retention type for the snapshot as given by the policy. When a WORM retention type is specified, the snapshot will be kept until the maximum of the snapshot retention time. During that time, the snapshot cannot be deleted. ''kNone'' implies there is no WORM retention set. ''kCompliance'' implies WORM retention is set for compliance reason. ''kAdministrative'' implies WORM retention is set for administrative purposes.' type: - string - 'null' enum: - kNone - kCompliance - kAdministrative x-go-name: WormRetentionType x-go-package: cohesity/iris/server/data/public TagAttribute: description: Specifies a VMware tag. type: object title: VMware Tag Attributes. properties: gcpTagType: description: 'Specifies the tag attribute type of GCP. Going forward, there will be an additional TagTypes for AWS as well. Specifies the type of the tag GCP entity refers to. ''kNetworkTag'' indicates a network tag present on instances. ''kLabel'' indicates a label (key-value pair) present on instances. ''kCustomMetadata'' indicates custom Metadata (key-value pair) present on instances.' type: - string - 'null' enum: - kNetworkTag - kLabel - kCustomMetadata x-go-name: GcpTagType id: description: Specifies the Coheisty id of the VM tag. type: - integer - 'null' format: int64 x-go-name: Id name: description: Specifies the VMware name of the VM tag. type: - string - 'null' x-go-name: Name uuid: description: 'Specifies the VMware Universally Unique Identifier (UUID) of the VM tag.' type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public Credentials: description: Specifies credentials to access a target source. type: object title: Credentials. properties: password: description: Specifies password of the username to access the target source. type: - string - 'null' x-go-name: Password username: description: Specifies username to access the target source. type: - string - 'null' x-go-name: Username x-go-package: cohesity/iris/server/data/public ThrottlingPolicyParameters: description: Specifies the throttling policy for a registered Protection Source. type: object title: Throttling Policy. properties: enforceMaxStreams: description: 'Specifies whether datastore streams are configured for all datastores that are part of the registered entity. If set to true, number of streams from Cohesity cluster to the registered entity will be limited to the value set for maxConcurrentStreams. If not set or set to false, there is no max limit for the number of concurrent streams.' type: - boolean - 'null' x-go-name: EnforceMaxStreams enforceRegisteredSourceMaxBackups: description: 'Specifies whether no. of backups are configured for the registered entity. If set to true, number of backups made by Cohesity cluster in the registered entity will be limited to the value set for RegisteredSourceMaxConcurrentBackups. If not set or set to false, there is no max limit for the number of concurrent backups.' type: - boolean - 'null' x-go-name: EnforceRegisteredSourceMaxBackups isEnabled: description: 'Indicates whether read operations to the datastores, which are part of the registered Protection Source, are throttled.' type: - boolean - 'null' x-go-name: IsEnabled latencyThresholds: description: 'Specifies the thresholds that should be applied to all datastores that are part of the registered Object.' $ref: '#/components/schemas/LatencyThresholds' maxConcurrentStreams: description: 'Specifies the limit on the number of streams Cohesity cluster will make concurrently to the datastores of the registered entity. This limit is enforced only when the flag enforceMaxStreams is set to true.' type: - integer - 'null' format: int32 x-go-name: MaxConcurrentStreams registeredSourceMaxConcurrentBackups: description: 'Specifies the limit on the number of backups Cohesity cluster will make concurrently to the registered entity. This limit is enforced only when the flag enforceRegisteredSourceMaxBackups is set to true.' type: - integer - 'null' format: int32 x-go-name: RegisteredSourceMaxConcurrentBackups x-go-package: cohesity/iris/server/data/public AcropolisProtectionSource: description: Specifies a Protection Source in Acropolis environment. type: object title: Acropolis Protection Source. properties: clusterUuid: description: 'Specifies the UUID of the Acropolis cluster instance to which this entity belongs to.' type: - string - 'null' x-go-name: ClusterUuid description: description: Specifies a description about the Protection Source. type: - string - 'null' x-go-name: Description mountPath: description: 'Specifies whether the VM is an agent VM. This is applicable to acropolis entity of type kVirtualMachine.' type: - boolean - 'null' x-go-name: IsAgentVm name: description: Specifies the name of the Acropolis Object. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of an Acropolis Protection Source Object such as ''kPrismCentral'', ''kHost'', ''kNetwork'', etc. Specifies the type of an Acropolis source entity. ''kPrismCentral'' indicates a collection of multiple Nutanix clusters. ''kStandaloneCluster'' indicates a single Nutanix cluster. ''kCluster'' indicates a Nutanix cluster managed by a Prism Central. ''kHost'' indicates an Acropolis host. ''kVirtualMachine'' indicates a Virtual Machine. ''kNetwork'' indicates a Virtual Machine network object. ''kStorageContainer'' represents a storage container object.' type: - string - 'null' enum: - kPrismCentral - kStandaloneCluster - kCluster - kHost - kVirtualMachine - kNetwork - kStorageContainer x-go-name: Type uuid: description: 'Specifies the UUID of the Acropolis Object. This is unique within the cluster instance. Together with clusterUuid, this entity is unique within the Acropolis environment.' type: - string - 'null' x-go-name: Uuid version: description: Specifies the version of an Acropolis cluster or standalone cluster. type: - string - 'null' x-go-name: Version x-go-package: cohesity/iris/server/data/public FlashBladeFileSystem: description: Specifies information about a Flash Blade File System in a Storage Array. type: object title: Flash Blade File System. properties: backupEnabled: description: 'Specifies whether the .snapshot directory exists on the file system. Backup is enabled only if the directory exists.' type: - boolean - 'null' x-go-name: BackupEnabled createdTimeMsecs: description: 'Specifies the time when the filesystem was created in Unix epoch time in milliseconds.' type: - integer - 'null' format: int64 x-go-name: CreatedTimeMsecs logicalCapacityBytes: description: Specifies the total capacity in bytes of the file system. type: - integer - 'null' format: int64 x-go-name: LogicalCapacityBytes logicalUsedBytes: description: 'Specifies the size of logical data currently represented on the file system in bytes.' type: - integer - 'null' format: int64 x-go-name: LogicalUsedBytes nfsInfo: description: 'Specifies information about an NFS export. This field is set if the file system supports protocol type ''kNfs''.' $ref: '#/components/schemas/FlashBladeNfsInfo' physicalUsedBytes: description: 'Specifies the size of physical data currently consumed by the file system. This includes the space used for the snapshots.' type: - integer - 'null' format: int64 x-go-name: PhysicalUsedBytes protocols: description: 'List of Protocols. Specifies the list of protocols enabled on the file system. ''kNfs'' indicates NFS exports are supported on Pure FlashBlade File System. ''kCifs2'' indicates CIFS/SMB Shares are supported on Pure FlashBlade File System. ''kHttp'' indicates object protocol over HTTP and HTTPS are supported.' type: - array - 'null' items: type: string enum: - kNfs - kCifs2 - kHttp x-go-name: Protocols uniqueUsedBytes: description: 'Specifies the size of physical data consumed by the file system itself not including the size of the snapshots.' type: - integer - 'null' format: int64 x-go-name: UniqueUsedBytes x-go-package: cohesity/iris/server/data/public UserInfo: description: Specifies struct with basic user details. type: object title: User Information. properties: domain: description: Specifies domain name of the user. type: - string - 'null' x-go-name: Domain sid: description: Specifies unique Security ID (SID) of the user. type: - string - 'null' x-go-name: Sid tenantId: description: Specifies the tenant to which the user belongs to. type: - string - 'null' x-go-name: TenantId userName: description: Specifies user name of the user. type: - string - 'null' x-go-name: UserName x-go-package: cohesity/iris/server/data/public ConnectorParameters: description: 'Specifies the parameters required to establish a connection with a particular environment.' type: object title: Connector Parameters. properties: endpoint: description: 'Specify an IP address or URL of the environment. (such as the IP address of the vCenter Server for a VMware environment).' type: - string - 'null' x-go-name: Endpoint environment: description: 'Specifies the environment like VMware, SQL, where the Protection Source exists. Supported environment types such as ''kView'', ''kSQL'', ''kVMware'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter. ''kVMware'' indicates the VMware Protection Source environment. ''kHyperV'' indicates the HyperV Protection Source environment. ''kSQL'' indicates the SQL Protection Source environment. ''kView'' indicates the View Protection Source environment. ''kPuppeteer'' indicates the Cohesity''s Remote Adapter. ''kPhysical'' indicates the physical Protection Source environment. ''kPure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''kAzure'' indicates the Microsoft''s Azure Protection Source environment. ''kNetapp'' indicates the Netapp Protection Source environment. ''kAgent'' indicates the Agent Protection Source environment. ''kGenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''kAcropolis'' indicates the Acropolis Protection Source environment. ''kPhsicalFiles'' indicates the Physical Files Protection Source environment. ''kIsilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''kGPFS'' indicates IBM''s GPFS Protection Source environment. ''kKVM'' indicates the KVM Protection Source environment. ''kAWS'' indicates the AWS Protection Source environment. ''kExchange'' indicates the Exchange Protection Source environment. ''kHyperVVSS'' indicates the HyperV VSS Protection Source environment. ''kOracle'' indicates the Oracle Protection Source environment. ''kGCP'' indicates the Google Cloud Platform Protection Source environment. ''kFlashBlade'' indicates the Flash Blade Protection Source environment. ''kAWSNative'' indicates the AWS Native Protection Source environment. ''kO365'' indicates the Office 365 Protection Source environment. ''kO365Outlook'' indicates Office 365 outlook Protection Source environment. ''kHyperFlex'' indicates the Hyper Flex Protection Source environment. ''kGCPNative'' indicates the GCP Native Protection Source environment. ''kAzureNative'' indicates the Azure Native Protection Source environment. ''kKubernetes'' indicates a Kubernetes Protection Source environment. ''kElastifile'' indicates Elastifile Protection Source environment. ''kAD'' indicates Active Directory Protection Source environment. ''kRDSSnapshotManager'' indicates AWS RDS Protection Source environment. ''kCassandra'' indicates Cassandra Protection Source environment. ''kMongoDB'' indicates MongoDB Protection Source environment. ''kCouchbase'' indicates Couchbase Protection Source environment. ''kHdfs'' indicates Hdfs Protection Source environment. ''kHive'' indicates Hive Protection Source environment. ''kHBase'' indicates HBase Protection Source environment.' type: - string - 'null' enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kNimble - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kAzureNative - kKubernetes - kElastifile - kAD - kRDSSnapshotManager - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase x-go-name: Environment id: description: 'Specifies a Unique id that is generated when the Source is registered. This is a convenience field that is used to maintain an index to different connection params.' type: - integer - 'null' format: int64 x-go-name: Id version: description: 'Version is updated each time the connector parameters are updated. This is used to discard older connector parameters.' type: - integer - 'null' format: int64 x-go-name: Version x-go-package: cohesity/iris/server/data/public VirtualDiskInfo: type: object title: Virtual Disk Information. properties: busNumber: description: Specifies the Id of the controller bus that controls the disk. type: - integer - 'null' format: int64 x-go-name: BusNumber controllerType: description: Specifies the controller type like SCSI, or IDE etc. type: - string - 'null' x-go-name: ControllerType filename: description: Specifies the host file name used as the virtual disk. type: - string - 'null' x-go-name: Filename unitNumber: description: 'Specifies the disk file name. This is the VMDK name and not the flat file name.' type: - integer - 'null' format: int64 x-go-name: UnitNumber x-go-package: cohesity/iris/server/data/public DagApplicationServerInfo: description: 'Specifies the information about the status of the Exchange Application Server which is a member of the DAG.' type: object title: Exchange DAG Application Server Information properties: fqdn: description: Specifies the fully qualified domain name of the Exchange Server. type: - string - 'null' x-go-name: Fqdn guid: description: Specifies the Guid of the Exchange Application Server. type: - string - 'null' x-go-name: Guid id: description: Specifies the entity id of the Exchange Application server. type: - integer - 'null' format: int64 x-go-name: Id name: description: Specifies the display name of the Exchange Application Server. type: - string - 'null' x-go-name: Name ownerId: description: 'Specifies the entity id of the owner entity of the Exchange Application Server.' type: - integer - 'null' format: int64 x-go-name: OwnerId status: description: 'Specifies the status of the registration of the Exchange Application Server. Specifies the status of registration of Exchange Application Server. ''kUnknown'' indicates the status is not known. ''kHealthy'' indicates the status is healty and is registered as Exchange Server. ''kUnHealthy'' indicates the exchange application is registered on the physical server but it is unreachable now. ''kUnregistered'' indicates the server is not registered as physical source. ''kUnreachable'' indicates the server is not reachable from the cohesity cluster or the cohesity protection server is not installed on the exchange server. ''kDetached'' indicates the server is removed from the ExchangeDAG.' type: - string - 'null' enum: - kUnknown - kHealthy - kUnHealthy - kUnregistered - kUreachable - kDetached x-go-name: Status totalSizeBytes: description: 'Specifies the total size of all Exchange database copies in all the Exchange Application Servers that are part of the DAG.' type: - integer - 'null' format: int64 x-go-name: TotalSizeBytes x-go-package: cohesity/iris/server/data/public AzureCredentials: description: Specifies the credentials to authenticate with Azure Cloud Platform. type: object title: Azure source Credentials. properties: applicationId: description: Specifies Application Id of the active directory of Azure account. type: - string - 'null' x-go-name: ApplicationId applicationKey: description: Specifies Application key of the active directory of Azure account. type: - string - 'null' x-go-name: ApplicationKey azureType: description: 'Specifies the entity type such as ''kSubscription'' if the environment is kAzure. Specifies the type of an Azure source entity. ''kSubscription'' indicates a billing unit within Azure account. ''kResourceGroup'' indicates a container that holds related resources. ''kVirtualMachine'' indicates a Virtual Machine in Azure environment. ''kStorageAccount'' represents a collection of storage containers. ''kStorageKey'' indicates a key required to access the storage account. ''kStorageContainer'' represents a storage container within a storage account. ''kStorageBlob'' represents a storage blog within a storage container. ''kStorageResourceGroup'' indicates a container that holds related storage resources. ''kNetworkSecurityGroup'' represents a network security group. ''kVirtualNetwork'' represents a virtual network. ''kNetworkResourceGroup'' indicates a container that holds related network resources. ''kSubnet'' represents a subnet within the virtual network. ''kComputeOptions'' indicates the number of CPU cores and memory size available for a type of a Virtual Machine.' type: - string - 'null' enum: - kSubscription - kResourceGroup - kVirtualMachine - kStorageAccount - kStorageKey - kStorageContainer - kStorageBlob - kStorageResourceGroup - kNetworkSecurityGroup - kVirtualNetwork - kNetworkResourceGroup - kSubnet - kComputeOptions x-go-name: AzureType subscriptionId: description: 'Specifies Subscription id inside a customer''s Azure account. It represents sub-section within the Azure account where a customer allows us to create VMs, storage account etc.' type: - string - 'null' x-go-name: SubscriptionId subscriptionType: description: 'Specifies the subscription type of Azure such as ''kAzureCommercial'' or ''kAzureGovCloud''. Specifies the subscription type of an Azure source entity. ''kAzureCommercial'' indicates a standard Azure subscription. ''kAzureGovCloud'' indicates a govt Azure subscription.' type: - string - 'null' enum: - kAzureCommercial - kAzureGovCloud x-go-name: SubscriptionType tenantId: description: Specifies Tenant Id of the active directory of Azure account. type: - string - 'null' x-go-name: TenantId x-go-package: cohesity/iris/server/data/public SqlSourceId: description: Specifies a unique id for a SQL Protection Source. type: object title: SQL Source Id. properties: createdDateMsecs: description: 'Specifies a unique identifier generated from the date the database is created or renamed. Cohesity uses this identifier in combination with the databaseId to uniquely identify a database.' type: - integer - 'null' format: int64 x-go-name: CreatedDateMsecs databaseId: description: 'Specifies a unique id of the database but only for the life of the database. SQL Server may reuse database ids. Cohesity uses the createDateMsecs in combination with this databaseId to uniquely identify a database.' type: - integer - 'null' format: int64 x-go-name: DatabaseId instanceId: description: 'Array of bytes that stores the SQL Server Instance id. Specifies unique id for the SQL Server instance. This id does not change during the life of the instance.' type: - array - 'null' items: type: integer format: uint8 x-go-name: InstanceId x-go-package: cohesity/iris/server/data/public AwsProtectionSource: description: Specifies a Protection Source in AWS environment. type: object title: AWS Protection Source. properties: accessKey: description: Specifies Access key of the AWS account. type: - string - 'null' x-go-name: AccessKey amazonResourceName: description: 'Specifies Amazon Resource Name (owner ID) of the IAM user, act as an unique identifier of as AWS entity.' type: - string - 'null' x-go-name: AmazonResourceName authMethod: description: 'Specifies the authentication method to be used for API calls. Specifies the authentication method to be used for API calls. ''kUseIAMUser'' indicates a user based authentication. ''kUseIAMRole'' indicates a role based authentication, used only for AWS CE.' type: - string - 'null' enum: - kUseIAMUser - kUseIAMRole x-go-name: AuthMethod awsFleetParams: description: 'Specifies information related to AWS fleets launched for various purposes. This will only be set for kIAMUser entity.' $ref: '#/components/schemas/AwsFleetParams' awsType: description: 'Specifies the entity type such as ''kIAMUser'' if the environment is kAWS. Specifies the type of an AWS source entity. ''kIAMUser'' indicates a unique user within an AWS account. ''kRegion'' indicates a geographical region in the global infrastructure. ''kAvailabilityZone'' indicates an availability zone within a region. ''kEC2Instance'' indicates a Virtual Machine running in AWS environment. ''kVPC'' indicates a virtual private cloud (VPC) network within AWS. ''kSubnet'' indicates a subnet inside the VPC. ''kNetworkSecurityGroup'' represents a network security group. ''kInstanceType'' represents various machine types. ''kKeyPair'' represents a pair of public and private key used to login into a Virtual Machine. ''kTag'' represents a tag attached to EC2 instance. ''kRDSOptionGroup'' represents a RDS option group for configuring database features. ''kRDSParameterGroup'' represents a RDS parameter group. ''kRDSInstance'' represents a RDS DB instance. ''kRDSSubnet'' represents a RDS subnet. ''kRDSTag'' represents a tag attached to RDS instance.' type: - string - 'null' enum: - kIAMUser - kRegion - kAvailabilityZone - kEC2Instance - kVPC - kSubnet - kNetworkSecurityGroup - kInstanceType - kKeyPair - kTag - kRDSOptionGroup - kRDSParameterGroup - kRDSInstance - kRDSSubnet - kRDSTag x-go-name: AwsType clusterNetworkInfo: description: 'Specifies information related to cluster. This is only valid for CE clusters. This is only populated for kIAMUser entity.' $ref: '#/components/schemas/FleetNetworkParams' dbEngineId: description: 'Specifies DB engine version info of the entity. This is populated only for RDSInstance, RDSOptionGroup and RDSParameterGroup entity types.' type: - string - 'null' x-go-name: DbEngineId hostType: description: 'Specifies the OS type of the Protection Source of type ''kVirtualMachine'' such as ''kWindows'' or ''kLinux''. overrideDescription: true ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: HostType iamRoleArn: description: 'Specifies the IAM role which will be used to access the security credentials required for API calls.' type: - string - 'null' x-go-name: IamRoleArn ipAddresses: description: Specifies the IP address of the entity of type 'kVirtualMachine'. type: - string - 'null' x-go-name: IpAddress name: description: 'Specifies the name of the Object set by the Cloud Provider. If the provider did not set a name for the object, this field is not set.' type: - string - 'null' x-go-name: Name ownerId: description: 'Specifies the owner id of the resource in AWS environment. With type, name and ownerId gives a globally unique identity to the AWS entity.' type: - string - 'null' x-go-name: OwnerId physicalSourceId: description: 'Specifies the Protection Source id of the registered Physical Host. If the cloud entity is protected using a Physical Agent, it must be registered as a physical host.' type: - integer - 'null' format: int64 x-go-name: PhysicalSourceId regionId: description: Specifies the region Id of the entity if the entity is an EC2 instance. type: - string - 'null' x-go-name: RegionId resourceId: description: Specifies the unique Id of the resource given by the cloud provider. type: - string - 'null' x-go-name: ResourceId restoreTaskId: description: 'Specifies the id of the "convert and deploy" restore task that created the entity in the cloud. It is required to support the DR-to-cloud usecase where we replicate an on-prem entity to a cluster running in cloud, bring it up using "convert and deploy" mechanism, protect it using a cloud job that uses physical adapter, and convert it back to the on-prem format before replication. Before replicating, we need to update the backup task state of the backed up entity using the on-prem entity and on-prem entity''s parent. The id is used to lookup the restore entity that contains details about the on-prem entity. It is set at the time of refreshing the cloud entity hierarchy if all the following conditions are met: Name of the current entity matches with name of any cloud entity deployed using the "convert and deploy" restore task. Restore entity associated with the above matched cloud entity has ''failed_over'' flag set to true in its cloud extension.' type: - integer - 'null' format: int64 x-go-name: RestoreTaskId secretAccessKey: description: Specifies Secret Access key of the AWS account. type: - string - 'null' x-go-name: SecretAccessKey subscriptionType: description: 'Specifies the subscription type of AWS such as ''kAWSCommercial'' or ''kAWSGovCloud''. Specifies the subscription type of an AWS source entity. ''kAWSCommercial'' indicates a standard AWS subscription. ''kAWSGovCloud'' indicates a govt AWS subscription.' type: - string - 'null' enum: - kAWSCommercial - kAWSGovCloud x-go-name: SubscriptionType tagAttributes: description: Specifies the list of AWS tag attributes. type: - array - 'null' items: $ref: '#/components/schemas/TagAttribute' x-go-name: TagAttributes type: description: 'Specifies the type of an AWS Protection Source Object such as ''kStorageContainer'', ''kVirtualMachine'', ''kVirtualNetwork'', etc. Specifies the type of an AWS source entity. ''kIAMUser'' indicates a unique user within an AWS account. ''kRegion'' indicates a geographical region in the global infrastructure. ''kAvailabilityZone'' indicates an availability zone within a region. ''kEC2Instance'' indicates a Virtual Machine running in AWS environment. ''kVPC'' indicates a virtual private cloud (VPC) network within AWS. ''kSubnet'' indicates a subnet inside the VPC. ''kNetworkSecurityGroup'' represents a network security group. ''kInstanceType'' represents various machine types. ''kKeyPair'' represents a pair of public and private key used to login into a Virtual Machine. ''kTag'' represents a tag attached to EC2 instance. ''kRDSOptionGroup'' represents a RDS option group for configuring database features. ''kRDSParameterGroup'' represents a RDS parameter group. ''kRDSInstance'' represents a RDS DB instance. ''kRDSSubnet'' represents a RDS subnet. ''kRDSTag'' represents a tag attached to RDS instance.' type: - string - 'null' enum: - kIAMUser - kRegion - kAvailabilityZone - kEC2Instance - kVPC - kSubnet - kNetworkSecurityGroup - kInstanceType - kKeyPair - kTag - kRDSOptionGroup - kRDSParameterGroup - kRDSInstance - kRDSSubnet - kRDSTag x-go-name: Type userAccountId: description: Specifies the account id derived from the ARN of the user. type: - string - 'null' x-go-name: UserAccountId userResourceName: description: Specifies the Amazon Resource Name (ARN) of the user. type: - string - 'null' x-go-name: UserResourceName x-go-package: cohesity/iris/server/data/public SanEnvJobParameters: description: 'Specifies job parameters applicable for all SAN Environment types Protection Sources in a Protection Job.' type: object title: SAN Environment Job Parameters. properties: maxSnapshotsOnPrimary: 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.' type: - integer - 'null' format: int64 x-go-name: MaxSnapshotsOnPrimary x-go-package: cohesity/iris/server/data/public SqlAagHostAndDatabases: description: 'Specifies AAGs and databases information on an SQL server. If AAGs exist on the server, specifies information about the AAG and databases in the group for each AAG found on the server.' type: object title: SQL AAG Host and Databases. properties: aagDatabases: description: Specifies a list of AAGs and database members in each AAG. type: - array - 'null' items: $ref: '#/components/schemas/AagAndDatabases' x-go-name: AagDatabases applicationNode: description: 'Specifies the subtree used to store application-level Objects. Different environments use the subtree to store application-level information. For example for SQL Server, this subtree stores the SQL Server instances running on a VM or Physical hosts.' $ref: '#/components/schemas/ProtectionSourceNode' databases: description: 'Specifies all database entities found on the server. Database may or may not be in an AAG.' type: - array - 'null' items: $ref: '#/components/schemas/ProtectionSource' x-go-name: Databases errorMessage: description: 'Specifies an error message when the host is not registered as an SQL host.' type: - string - 'null' x-go-name: ErrorMessage unknownHostName: description: 'Specifies the name of the host that is not registered as an SQL server on Cohesity Cluser.' type: - string - 'null' x-go-name: UnknownHostName x-go-package: cohesity/iris/server/data/public HostSettingsCheckResult: description: Specifies the result of various checks performed internally on host. type: object title: Host Setting Check Result. properties: checkType: description: 'Specifies the type of the check internally performed. Specifies the type of the host check performed internally. ''kIsAgentPortAccessible'' indicates the check for agent port access. ''kIsAgentRunning'' indicates the status for the Cohesity agent service. ''kIsSQLWriterRunning'' indicates the status for SQLWriter service. ''kAreSQLInstancesRunning'' indicates the run status for all the SQL instances in the host. ''kCheckServiceLoginsConfig'' checks the privileges and sysadmin status of the logins used by the SQL instance services, Cohesity agent service and the SQLWriter service. ''kCheckSQLFCIVIP'' checks whether the SQL FCI is registered with a valid VIP or FQDN. ''kCheckSQLDiskSpace'' checks whether volumes containing SQL DBs have at least 10% free space.' type: - string - 'null' enum: - kIsAgentPortAccessible - kIsAgentRunning - kIsSQLWriterRunning - kAreSQLInstancesRunning - kCheckServiceLoginsConfig - kCheckSQLFCIVIP - kCheckSQLDiskSpace x-go-name: CheckType resultType: description: 'Specifies the type of the result returned after performing the internal host check. Specifies the type of the host check result performed internally. ''kPass'' indicates that the respective check was successful. ''kFail'' indicates that the respective check failed as some mandatory setting is not met ''kWarning'' indicates that the respective check has warning as certain non-mandatory setting is not met.' type: - string - 'null' enum: - kPass - kFail - kWarning x-go-name: ResultType userMessage: description: Specifies a descriptive message for failed/warning types. type: - string - 'null' x-go-name: UserMessage x-go-package: cohesity/iris/server/data/public OracleAppParams: description: 'Specifies special settings applicable for a app entity i.e database/dataguard.' type: object title: Oracle App Params. properties: databaseAppId: description: Specifies the source entity id of the selected app entity. type: - integer - 'null' format: int64 x-go-name: DatabaseAppId nodeChannelList: description: 'Array of database node channel info. Specifies the node channel info for all the databases of app entity. Length of this array will be 1 for RAC and Standalone setups.' type: - array - 'null' items: $ref: '#/components/schemas/OracleDatabaseNodeChannel' x-go-name: NodeChannelList x-go-package: cohesity/iris/server/data/public RemoteJobScript: description: 'Provides details about the Remote Adapter associated with a ''kPuppeteer'' Protection Job.' type: object title: Remote Adapter. properties: fullBackupScript: description: 'Specifies the script that should run for the Full (no CBT) backup schedule of a Remote Adapter ''kPuppeteer'' Job. This field is mandatory if the Policy associated with this Job has a Full (no CBT) backup schedule and this is Remote Adapter ''kPuppeteer'' Job.' title: Full (No CBT) Script. allOf: - $ref: '#/components/schemas/RemoteScriptPathAndParams' incrementalBackupScript: description: 'Specifies the script that should run for the CBT-based backup schedule of a Remote Adapter ''kPuppeteer'' Job. A CBT-based backup schedule is utilizing Change Block Tracking when capturing Snapshots. This field is mandatory if the Policy associated with this Job has a CBT-based backup schedule and this is Remote Adapter ''kPuppeteer'' Job.' title: CBT-based Script. allOf: - $ref: '#/components/schemas/RemoteScriptPathAndParams' logBackupScript: description: 'Specifies the script that should run for the Log backup schedule of a Remote Adapter ''kPuppeteer'' Job. This field is mandatory if the Policy associated with this Job has a Log backup schedule and this is Remote Adapter ''kPuppeteer'' Job.' title: Log Script. allOf: - $ref: '#/components/schemas/RemoteScriptPathAndParams' remoteHost: description: 'Specifies the remote host where the remote scripts are executed. This field must be set for Remote Adapter Jobs.' allOf: - $ref: '#/components/schemas/RemoteHost' username: description: 'Specifies the username that will be used to login to the remote host. For host type ''kLinux'', it is expected that user has setup the password-less access. So only username field is required.' type: - string - 'null' x-go-name: Username x-go-package: cohesity/iris/server/data/public KubernetesProtectionSource: description: Specifies a Protection Source in Kubernetes environment. type: object title: Kubernetes Protection Source. properties: description: description: Specifies an optional description of the object. type: - string - 'null' x-go-name: Description name: description: Specifies a unique name of the Protection Source. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of the entity in a Kubernetes environment. Specifies the type of a Kubernetes Protection Source. ''kCluster'' indicates a Kubernetes Cluster. ''kNamespace'' indicates a namespace in a Kubernetes Cluster. ''kService'' indicates a service running on a Kubernetes Cluster.' type: - string - 'null' enum: - kCluster - kNamespace - kService x-go-name: Type uuid: description: Specifies the UUID of the object. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public AdDomain: description: Specifies information about an AD Domain. type: object title: AD Domain. properties: dnsRoot: description: Specifies DNS root. type: - string - 'null' x-go-name: DnsRoot forest: description: Specifies AD forest name. type: - string - 'null' x-go-name: Forest identity: description: Specifies Identity information of the domain. $ref: '#/components/schemas/AdDomainIdentity' netbiosName: description: Specifies AD NetBIOS name. type: - string - 'null' x-go-name: NetbiosName parentDomain: description: Specifies parent domain name. type: - string - 'null' x-go-name: ParentDomain tombstoneDays: description: Specifies tombstone time in days. type: - integer - 'null' format: uint32 x-go-name: TombstoneDays x-go-package: cohesity/iris/server/data/public RdsParams: description: Specifies rds params for the restore operation. type: object title: RDS parameters. required: - dbInstanceId properties: availabilityZoneId: description: Entity representing the availability zone to use while restoring the DB. type: - integer - 'null' format: int64 x-go-name: AvailabilityZoneId dbInstanceId: description: 'The DB instance identifier to use for the restored DB. This field is required.' type: - string - 'null' x-go-name: DbInstanceId dbOptionGroupId: description: Entity representing the RDS option group to use while restoring the DB. type: - integer - 'null' format: int64 x-go-name: DbOptionGroupId dbParameterGroupId: description: Entity representing the RDS parameter group to use while restoring the DB. type: - integer - 'null' format: int64 x-go-name: DbParameterGroupId dbPort: description: Port to use for the DB in the restored RDS instance. type: - integer - 'null' format: int32 x-go-name: DbPort enableAutoMinorVersionUpgrade: description: Whether to enable auto minor version upgrade in the restored DB. type: - boolean - 'null' x-go-name: EnableAutoMinorVersionUpgrade enableCopyTagsToSnapshots: description: Whether to enable copying of tags to snapshots of the DB. type: - boolean - 'null' x-go-name: EnableCopyTagsToSnapshots enableDbAuthentication: description: Whether to enable IAM authentication for the DB. type: - boolean - 'null' x-go-name: EnableDbAuthentication enablePublicAccessibility: description: Whether this DB will be publicly accessible or not. type: - boolean - 'null' x-go-name: EnablePublicAccessibility isMultiAzDeployment: description: Whether this is a multi-az deployment or not. type: - boolean - 'null' x-go-name: IsMultiAzDeployment x-go-package: cohesity/iris/server/data/public VolumeSecurityInfo: description: Specifies information about NetApp volume security settings. type: object title: Volume Security Information. properties: groupId: description: Specifies the Unix group ID for this volume. 0 indicates the root id. type: - integer - 'null' format: int32 x-go-name: GroupId permissions: description: Specifies the Unix permission bits in octal string format. type: - string - 'null' x-go-name: Permissions style: description: 'Specifies the security style associated with this volume. Specifies the type of a NetApp Volume. ''kUnix'' indicates Unix-style security. ''kNtfs'' indicates Windows NTFS-style security. ''kMixed'' indicates mixed-style security. ''kUnified'' indicates Unified-style security.' type: - string - 'null' enum: - kUnix - kNtfs - kMixed - kUnified x-go-name: Style userId: description: Specifies the Unix user id for this volume. 0 indicates the root id. type: - integer - 'null' format: int32 x-go-name: UserId x-go-package: cohesity/iris/server/data/public RegisterApplicationServersParameters: description: 'Specifies the parameters required to register Application Servers running in a Protection Source.' type: object title: Register Application Servers Parameters. properties: applications: description: 'Specifies the types of applications such as ''kSQL'', ''kExchange'', ''kAD'' running on the Protection Source. overrideDescription: true Supported environment types such as ''kView'', ''kSQL'', ''kVMware'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter. ''kVMware'' indicates the VMware Protection Source environment. ''kHyperV'' indicates the HyperV Protection Source environment. ''kSQL'' indicates the SQL Protection Source environment. ''kView'' indicates the View Protection Source environment. ''kPuppeteer'' indicates the Cohesity''s Remote Adapter. ''kPhysical'' indicates the physical Protection Source environment. ''kPure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''kAzure'' indicates the Microsoft''s Azure Protection Source environment. ''kNetapp'' indicates the Netapp Protection Source environment. ''kAgent'' indicates the Agent Protection Source environment. ''kGenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''kAcropolis'' indicates the Acropolis Protection Source environment. ''kPhsicalFiles'' indicates the Physical Files Protection Source environment. ''kIsilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''kGPFS'' indicates IBM''s GPFS Protection Source environment. ''kKVM'' indicates the KVM Protection Source environment. ''kAWS'' indicates the AWS Protection Source environment. ''kExchange'' indicates the Exchange Protection Source environment. ''kHyperVVSS'' indicates the HyperV VSS Protection Source environment. ''kOracle'' indicates the Oracle Protection Source environment. ''kGCP'' indicates the Google Cloud Platform Protection Source environment. ''kFlashBlade'' indicates the Flash Blade Protection Source environment. ''kAWSNative'' indicates the AWS Native Protection Source environment. ''kO365'' indicates the Office 365 Protection Source environment. ''kO365Outlook'' indicates Office 365 outlook Protection Source environment. ''kHyperFlex'' indicates the Hyper Flex Protection Source environment. ''kGCPNative'' indicates the GCP Native Protection Source environment. ''kAzureNative'' indicates the Azure Native Protection Source environment. ''kKubernetes'' indicates a Kubernetes Protection Source environment. ''kElastifile'' indicates Elastifile Protection Source environment. ''kAD'' indicates Active Directory Protection Source environment. ''kRDSSnapshotManager'' indicates AWS RDS Protection Source environment. ''kCassandra'' indicates Cassandra Protection Source environment. ''kMongoDB'' indicates MongoDB Protection Source environment. ''kCouchbase'' indicates Couchbase Protection Source environment. ''kHdfs'' indicates Hdfs Protection Source environment. ''kHive'' indicates Hive Protection Source environment. ''kHBase'' indicates HBase Protection Source environment.' type: - array - 'null' items: type: string enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kNimble - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kAzureNative - kKubernetes - kElastifile - kAD - kRDSSnapshotManager - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase x-go-name: Applications hasPersistentAgent: description: 'Set this to true if a persistent agent is running on the host. If this is specified, then credentials would not be used to log into the host environment. This mechanism may be used in environments such as VMware to get around UAC permission issues by running the agent as a service with the right credentials. If this field is not specified, credentials must be specified.' type: - boolean - 'null' x-go-name: HasPersistentAgent password: description: Specifies password of the username to access the target source. type: - string - 'null' x-go-name: Password protectionSourceId: description: 'Specifies the Id of the Protection Source that contains one or more Application Servers running on it.' type: - integer - 'null' format: int64 x-go-name: ProtectionSourceId username: description: Specifies username to access the target source. type: - string - 'null' x-go-name: Username x-go-package: cohesity/iris/server/data/public SnapshotCloudCopyPolicy: description: 'Specifies settings for copying Snapshots to Cloud. This also specifies the retention policy that should be applied to Snapshots after they have been copied to Cloud.' type: object title: Cloud Deploy Policy. properties: Id: description: 'Specified the Id for a snapshot copy policy. This is generated when the policy is created.' type: - string - 'null' copyPartial: description: 'Specifies if Snapshots are copied from the first completely successful Job Run or the first partially successful Job Run occurring at the start of the replication schedule. If true, Snapshots are copied from the first Job Run occurring at the start of the replication schedule, even if first Job Run was not completely successful i.e. Snapshots were not captured for all Objects in the Job. If false, Snapshots are copied from the first Job Run occurring at the start of the replication schedule that was completely successful i.e. Snapshots for all the Objects in the Job were successfully captured.' type: - boolean - 'null' x-go-name: CopyPartial datalockConfig: description: 'Specifies WORM retention type for the copy target snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept for the last N days as specified in the duration of the datalock. During that time, the snapshots cannot be deleted.' $ref: '#/components/schemas/DataLockConfig' daysToKeep: description: Specifies the number of days to retain copied Snapshots on the target. type: - integer - 'null' format: int64 x-go-name: DaysToKeep multiplier: description: 'Specifies a factor to multiply the periodicity by, to determine the copy schedule. For example if set to 2 and the periodicity is hourly, then Snapshots from the first eligible Job Run for every 2 hour period is copied.' type: - integer - 'null' format: int32 x-go-name: Multiplier periodicity: description: 'Specifies the frequency that Snapshots should be copied to the specified target. Used in combination with multiplier. ''kEvery'' means that the Snapshot copy occurs after the number of Job Runs equals the number specified in the multiplier. ''kHour'' means that the Snapshot copy occurs hourly at the frequency set in the multiplier, for example if multiplier is 2, the copy occurs every 2 hours. ''kDay'' means that the Snapshot copy occurs daily at the frequency set in the multiplier. ''kWeek'' means that the Snapshot copy occurs weekly at the frequency set in the multiplier. ''kMonth'' means that the Snapshot copy occurs monthly at the frequency set in the multiplier. ''kYear'' means that the Snapshot copy occurs yearly at the frequency set in the multiplier.' type: - string - 'null' enum: - kEvery - kHour - kDay - kWeek - kMonth - kYear x-go-name: Periodicity target: description: 'Specifies the details about CloudDeploy target where backup snapshots may be converted and stored.' $ref: '#/components/schemas/CloudDeployTargetDetails' x-go-package: cohesity/iris/server/data/public HiveConnectParams: description: 'Specifies an Object containing information about a registered Hive source.' type: object title: Hive Connect Params. properties: hdfsEntityId: description: Specifies the entity id of the HDFS source for this Hive type: - integer - 'null' format: int64 x-go-name: HdfsEntityId kerberosPrincipal: description: Specifies the kerberos principal. type: - string - 'null' x-go-name: KerberosPrincipal metastore: description: Specifies the Hive metastore host. type: - string - 'null' x-go-name: Metastore thriftPort: description: Specifies the Hive metastore thrift Port type: - integer - 'null' format: int32 x-go-name: ThriftPort x-go-package: cohesity/iris/server/data/public ContinuousSchedule: description: 'Specifies the time interval between two Job Runs of a continuous backup schedule and any blackout periods when new Job Runs should NOT be started.' type: object title: Continuous Schedule. properties: backupIntervalMins: description: 'If specified, this field defines the time interval in minutes when new Job Runs are started.' type: - integer - 'null' format: int64 x-go-name: BackupIntervalMins x-go-package: cohesity/iris/server/data/public DatastoreInfo: type: object title: Datastore Information. properties: capacity: description: Specifies the capacity of the datastore in bytes. type: - integer - 'null' format: uint64 x-go-name: Capacity freeSpace: description: Specifies the available space on the datastore in bytes. type: - integer - 'null' format: uint64 x-go-name: FreeSpace x-go-package: cohesity/iris/server/data/public HBaseProtectionSource: description: Specifies an Object representing HBase. type: object title: HBase Protection Source. properties: name: description: Specifies the instance name of the HBase entity. type: - string - 'null' x-go-name: Name tableInfo: description: 'Information of a HBase Table, only valid for an entity of type kTable.' $ref: '#/components/schemas/HBaseTable' type: description: 'Specifies the type of the managed Object in HBase Protection Source. Specifies the type of an HBase source entity. ''kCluster'' indicates a HBase cluster distributed over several physical nodes. ''kNamespace'' indicates a Namespace in the HBase environment. ''kTable'' indicates a Table in the HBase environment.' type: - string - 'null' enum: - kCluster - kNamespace - kTable x-go-name: Type uuid: description: Specifies the UUID for the HBase entity. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public ProtectedVmInfo: description: Specifies the Protection Jobs information of a VM. type: object title: Protected VM Information. properties: protectionJobs: description: Specifies the list of Protection Jobs that protect the VM. type: - array - 'null' items: $ref: '#/components/schemas/ProtectionJob' x-go-name: ProtectionJobs protectionPolicies: description: Specifies the list of Policies that are used by the Protection Jobs. type: - array - 'null' items: $ref: '#/components/schemas/ProtectionPolicy' x-go-name: ProtectionPolicies protectionSource: description: Specifies a VM that is being protected on the Cohesity Cluster. $ref: '#/components/schemas/ProtectionSource' stats: description: Specifies the protection stats of VM. allOf: - $ref: '#/components/schemas/ProtectionSummary' x-go-package: cohesity/iris/server/data/public SourceSpecialParameter: description: 'Specifies additional special settings for a single Source in a Protection Job. This Source must be a leaf node in the Source tree.' type: object title: Source Special Parameters. properties: adSpecialParameters: description: 'Specifies additional special parameters that are applicable only to Protection Sources of ''kAD'' type.' $ref: '#/components/schemas/ApplicationSpecialParameters' exchangeSpecialParameters: description: 'Specifies additional special parameters that are applicable only to Protection Sources of ''kExchange'' type.' $ref: '#/components/schemas/ApplicationSpecialParameters' oracleSpecialParameters: description: 'Specifies additional special parameters that are applicable only to Protection Sources of ''kOracle'' type.' $ref: '#/components/schemas/OracleSpecialParameters' physicalSpecialParameters: description: 'Specifies additional special parameters that are applicable only to Sources of ''kHost'' type in a kPhysical environment.' $ref: '#/components/schemas/PhysicalSpecialParameters' skipIndexing: description: 'Specifies not to index the objects in the Protection Source when backing up.' type: - boolean - 'null' x-go-name: SkipIndexing sourceId: description: 'Specifies the object id of the Protection Source that these special settings apply. This field must refer to a leaf node such a VM or a Physical Server.' type: - integer - 'null' format: int64 x-go-name: SourceId sqlSpecialParameters: description: 'Specifies additional special parameters that are applicable only to Protection Sources of ''kSQL'' type.' $ref: '#/components/schemas/ApplicationSpecialParameters' truncateExchangeLog: description: 'If true, after the Cohesity Cluster successfully captures a Snapshot during a Job Run, the Cluster truncates the Exchange transaction logs on a Microsoft Exchange Server. The default value is false. This field is deprecated. Use the field in ApplicationParameters inside source specific parameter. deprecated: true' type: - boolean - 'null' x-go-name: TruncateExchangeLog vmCredentials: description: 'Specifies the administrator credentials to log in to the guest Windows system of a VM that hosts the Microsoft Exchange Server. If truncateExchangeLog is set to true and the specified source is a VM, administrator credentials to log in to the guest Windows system of the VM must be provided to truncate the logs. This field is only applicable to Sources in the kVMware environment. This field is deprecated. Use the field in VmCredentials inside source specific parameter. deprecated: true' title: VM Credentials. allOf: - $ref: '#/components/schemas/Credentials' vmwareSpecialParameters: description: 'Specifies additional special parameters that are applicable only to Protection Sources of ''kVMware'' type.' $ref: '#/components/schemas/VmwareSpecialParameters' x-go-package: cohesity/iris/server/data/public CouchbaseConnectParams: description: 'Specifies an Object containing information about a registered couchbase source.' type: object title: Couchbase Connect Params. properties: carrierDirectPort: description: Specifies the Carrier direct/sll port. type: - integer - 'null' format: int32 x-go-name: CarrierDirectPort httpDirectPort: description: Specifies the HTTP direct/sll port. type: - integer - 'null' format: int32 x-go-name: HttpDirectPort requiresSsl: description: Specifies whether this cluster allows connection through SSL only. type: - boolean - 'null' x-go-name: RequiresSsl seeds: description: Specifies the Seeds of this Couchbase Cluster. type: - array - 'null' items: type: string x-go-name: Seeds x-go-package: cohesity/iris/server/data/public HypervProtectionSource: description: Specifies a Protection Source in HyperV environment. type: object title: HyperV Protection Source. properties: agents: description: 'Array of Agents on the Physical Protection Source. Specifiles the agents running on the HyperV Protection Source and the status information.' type: - array - 'null' items: $ref: '#/components/schemas/AgentInformation' x-go-name: Agents backupType: description: 'Specifies the type of backup supported by the VM. ''kRctBackup'', ''kVssBackup'' Specifies the type of an HyperV datastore object. ''kRctBackup'' indicates backup is done using RCT/checkpoints. ''kVssBackup'' indicates backup is done using VSS.' type: - string - 'null' enum: - kRctBackup - kVssBackup x-go-name: BackupType buildNumber: description: Specifies the build number for HyperV SCVMM Servers. type: - string - 'null' x-go-name: BuildNumber clusterName: description: Specifies the cluster name for 'kHostCluster' objects. type: - string - 'null' x-go-name: ClusterName datastoreInfo: description: Specifies additional information for 'kDatastore' objects. $ref: '#/components/schemas/HypervDatastore' description: description: Specifies a description about the Protection Source. type: - string - 'null' x-go-name: Description hostType: description: 'Specifies host OS type for ''kVirtualMachine'' objects. ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: HostType hypervUuid: description: Specifies the UUID for 'kVirtualMachine' HyperV objects. type: - string - 'null' x-go-name: HypervUuid name: description: Specifies the name of the HyperV Object. type: - string - 'null' x-go-name: Name tagAttributes: description: 'Specifies the list of VM Tag attributes associated with this Object.' type: - array - 'null' items: $ref: '#/components/schemas/TagAttribute' x-go-name: TagAttributes type: description: 'Specifies the type of an HyperV Protection Source Object such as ''kSCVMMServer'', ''kStandaloneHost'', ''kNetwork'', etc. overrideDescription: true Specifies the type of an HyperV Protection Source. ''kSCVMMServer'' indicates a collection of root folders clusters. ''kStandaloneHost'' indicates a single Nutanix cluster. ''kStandaloneCluster'' indicates a single Nutanix cluster. ''kHostGroup'' indicates a Nutanix cluster managed by a Prism Central. ''kHypervHost'' indicates an HyperV host. ''kHostCluster'' indicates a Nutanix cluster managed by a Prism Central. ''kVirtualMachine'' indicates a Virtual Machine. ''kNetwork'' indicates a Virtual Machine network object. ''kDatastore'' represents a storage container object. ''kTag'' indicates a tag type object. ''kCustomProperty'' indicates a custom property including tag type.' type: - string - 'null' enum: - kSCVMMServer - kStandaloneHost - kStandaloneCluster - kHostGroup - kHypervHost - kHostCluster - kVirtualMachine - kNetwork - kDatastore - kTag - kCustomProperty x-go-name: Type uuid: description: 'Specifies the UUID of the Object. This is unique within the HyperV environment.' type: - string - 'null' x-go-name: Uuid vmInfo: description: Specifies additional information for 'kVirtualMachine' objects. $ref: '#/components/schemas/HypervVirtualMachine' windowsVersion: description: Specifies the windows version for HyperV hosts. type: - string - 'null' x-go-name: WindowsVersion x-go-package: cohesity/iris/server/data/public Office365EnvJobParameters: description: 'Specifies Office365 parameters applicable for all Office365 Environment type Protection Sources in a Protection Job. This encapsulates both OneDrive & Mailbox parameters.' type: object title: Office365 Environment Job Parameters. properties: onedriveParameters: description: Specifies OneDrive backup parameters. $ref: '#/components/schemas/OneDriveEnvJobParameters' outlookParameters: description: Specifies Outlook backup parameters. $ref: '#/components/schemas/OutlookEnvJobParameters' x-go-package: cohesity/iris/server/data/public RemoteHost: description: Specifies the settings required to connect to a remote host. type: object title: Remote Host. properties: address: description: 'Specifies the address (IP, hostname or FQDN) of the remote host that will run the script.' type: - string - 'null' x-go-name: Address type: description: 'Specifies the OS type of the remote host that will run the script. Currently only ''kLinux'' is supported. ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: Type x-go-package: cohesity/iris/server/data/public FlashBladeNfsInfo: description: 'Specifies information specific to NFS protocol exposed by Pure Flash Blade file system.' type: object title: Flash Blade NFS Information. properties: exportRules: description: 'Specifies NFS protocol export rules. Rules are in the form host(options). host represents one of the following categories: IP address in the form ddd.ddd.ddd.ddd for IPv4, or xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx for IPv6. Netmask in the form ddd.ddd.ddd.ddd/dd for IPv4, or xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx for IPv6. Wildcard in the form * to represent all clients options in parenthesis represents a comma-separated list of NFS export options. Valid export options are rw, ro, root_squash, no_root_squash, and fileid_32bit.' type: - string - 'null' x-go-name: ExportRules x-go-package: cohesity/iris/server/data/public IsilonProtectionSource: description: Specifies a Protection Source in Isilon OneFs environment. type: object title: Isilon Protection Source. properties: accessZone: description: 'Specifies an access zone in an Isilon OneFs file system. This is set only when the entity type is ''kZone''.' $ref: '#/components/schemas/IsilonAccessZone' cluster: description: 'Specifies information of an Isilon OneFs Cluster. This is set only when the entity type is ''kCluster''.' $ref: '#/components/schemas/IsilonCluster' mountPoint: description: 'Specifies information about a mount point in an Isilon OneFs file system. This is set only when the entity type is ''kMountPoint''.' $ref: '#/components/schemas/IsilonMountPoint' name: description: Specifies a unique name of the Protection Source. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of the entity in an Isilon OneFs file system like ''kCluster'', ''kZone'', or, ''kMountPoint''. ''kCluster'' indicates an Isilon OneFs Cluster. ''kZone'' indicates an access zone in an Isilon OneFs Cluster. ''kMountPoint'' indicates a mount point exposed by an Isilon OneFs Cluster.' type: - string - 'null' enum: - kCluster - kZone - kMountPoint x-go-name: Type x-go-package: cohesity/iris/server/data/public GpfsFileset: description: Specifies information about a fileset in a GPFS file system. type: object title: GPFS File Set. properties: id: description: Specifies the id of the fileset. type: - integer - 'null' format: uint64 x-go-name: Id isIndependentFileset: description: If the given fileset is an Independent fileset or not. type: - boolean - 'null' x-go-name: IsIndependentFileset name: description: Name of the filesystem associated with the fileset type: - string - 'null' x-go-name: FilesystemName path: description: Specifies the absolute path of the fileset. type: - string - 'null' x-go-name: Path protocols: description: 'Specifies GPFS supported Protocol information enabled on GPFS File System ''kNfs'' indicates NFS exports in a GPFS fileset. ''kSmb'' indicates CIFS/SMB Shares in a GPFS fileset.' type: - array - 'null' items: type: string enum: - kNfs - kSmb x-go-name: Protocols x-go-package: cohesity/iris/server/data/public RegisteredApplicationServer: description: 'Specifies an Application Server and the Protection Source that registered the Application Server.' type: object title: Registered Application Server. properties: applicationServer: description: 'Specifies the child subtree used to store additional application-level Objects. Different environments use the subtree to store application-level information. For example for SQL Server, this subtree stores the SQL Server instances running on a VM.' title: Application Server and the subtrees below them. allOf: - $ref: '#/components/schemas/ProtectionSourceNode' registeredProtectionSource: description: 'Specifies the Protection Source like a VM or Physical Server that registered the Application Server.' allOf: - $ref: '#/components/schemas/ProtectionSource' x-go-package: cohesity/iris/server/data/public CouchbaseProtectionSource: description: Specifies an Object representing Couchbase. type: object title: Couchbase Protection Source. properties: bucketInfo: description: 'Information of a Couchbase Bucket, only valid for an entity of type kBucket.' $ref: '#/components/schemas/CouchbaseBucket' clusterInfo: description: 'Information of a couchbase cluster, only valid for an entity of type kCluster.' $ref: '#/components/schemas/CouchbaseCluster' name: description: Specifies the instance name of the Couchbase entity. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of the managed Object in Couchbase Protection Source. Specifies the type of an Couchbase source entity. ''kCluster'' indicates a Couchbase cluster distributed over several physical nodes. ''kBucket'' indicates a bucket within the Couchbase environment.' type: - string - 'null' enum: - kCluster - kBucket x-go-name: Type uuid: description: Specifies the UUID for the Couchbase entity. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public ClusterNetworkingEndpoint: description: Specifies information about end point. type: object title: Cluster Networking Endpoint. properties: fqdn: description: The Fully Qualified Domain Name. type: - string - 'null' x-go-name: Fqdn ipv4Addr: description: The IPv4 address. type: - string - 'null' x-go-name: Ipv4Addr ipv6Addr: description: The IPv6 address. type: - string - 'null' x-go-name: Ipv6Addr x-go-package: cohesity/iris/server/data/public SQLServerInstanceVersion: description: Specifies the Server Instance Version. type: object title: SQL Server Instance Version. properties: build: description: Specifies the build. type: - integer - 'null' format: int32 x-go-name: Build majorVersion: description: Specifies the major version. type: - integer - 'null' format: int32 x-go-name: MajorVersion minorVersion: description: Specifies the minor version. type: - integer - 'null' format: int32 x-go-name: MinorVersion revision: description: Specifies the revision. type: - integer - 'null' format: int32 x-go-name: Revision versionString: description: Specifies the version string. type: - string - 'null' x-go-name: VersionString x-go-package: cohesity/iris/server/data/public HypervVirtualMachine: description: Specifies information about a VirtualMachine Object in HyperV environment. type: object title: HyperV VirtualMachine Object. properties: isHighlyAvailable: description: Specifies whether the VM is Highly Available or not. type: - boolean - 'null' x-go-name: IsHighlyAvailable version: description: Specifies the version of the VM. For example, 8.0, 5.0 etc. type: - string - 'null' x-go-name: Version vmBackupStatus: description: 'Specifies the status of the VM for backup purpose. overrideDescription: true Specifies the backup status of a HyperV Virtual Machine object. ''kSupported'' indicates the agent on the VM can do backup. ''kUnsupportedConfig'' indicates the agent on the VM cannot do backup. ''kMissing'' indicates the VM is not found in SCVMM.' type: - string - 'null' enum: - kSupported - kUnsupportedConfig - kMissing x-go-name: VmBackupStatus vmBackupType: description: 'Specifies the type of backup supported by the VM. overrideDescription: true Specifies the type of an HyperV datastore object. ''kRctBackup'' indicates backup is done using RCT/checkpoints. ''kVssBackup'' indicates backup is done using VSS.' type: - string - 'null' enum: - kRctBackup - kVssBackup x-go-name: VmBackupType x-go-package: cohesity/iris/server/data/public NasProtectionSource: description: Specifies a Protection Source in a Generic NAS environment. type: object title: Generic NAS Protection Source. properties: description: description: Specifies a description about the Protection Source. type: - string - 'null' x-go-name: Description mountPath: description: 'Specifies the mount path of this NAS. For example, for a NFS mount point, this should be in the format of IP or hostname:/foo/bar.' type: - string - 'null' x-go-name: MountPath name: description: Specifies the name of the NetApp Object. type: - string - 'null' x-go-name: Name protocol: description: 'Specifies the protocol used by the NAS server. Specifies the protocol used by a NAS server. ''kNfs3'' indicates NFS v3 protocol. ''kCifs1'' indicates CIFS v1.0 protocol.' type: - string - 'null' enum: - kNfs3 - kCifs1 x-go-name: Protocol skipValidation: description: Specifies whether to skip validation of the given mount point. type: - boolean - 'null' x-go-name: SkipValidation type: description: 'Specifies the type of a Protection Source Object in a generic NAS Source such as ''kGroup'', or ''kHost''. Specifies the kind of NAS mount. ''kGroup'' indicates top level node that holds individual NAS hosts. ''kHost'' indicates a single NAS path that can be mounted. ''kDfsGroup'' indicates a DFS group containing top level directories mapped to different servers. ''kDfsTopDir'' indicates a top level directory inside a DFS group, discovered when registering a DFS group.' type: - string - 'null' enum: - kGroup - kHost - kDfsGroup - kDfsTopDir x-go-name: Type x-go-package: cohesity/iris/server/data/public DagInfo: description: Specifies the information about the DAG(Database availability group). type: object title: Exchange DAG Information properties: dagApplicationServerInfoList: description: 'Specifies the status of all the Exchange Application Servers that are part of this DAG.' type: - array - 'null' items: $ref: '#/components/schemas/DagApplicationServerInfo' x-go-name: DagApplicationServerInfoList exchangeDagProtectionPreference: description: 'Specifies information about the preference order while choosing between which database copy of the database which is part of DAG should be protected.' $ref: '#/components/schemas/ExchangeDAGProtectionPreference' guid: description: Specifies Unique GUID for the DAG. type: - string - 'null' x-go-name: Guid name: description: Specifies display name of the DAG. type: - string - 'null' x-go-name: Name x-go-package: cohesity/iris/server/data/public SnapshotInfo: description: 'Specifies details about the snapshot task created to backup or copy one source object like a VM.' type: object title: Snapshot Information. properties: environment: description: 'Specifies the environment type (such as kVMware or kSQL) that contains the source to backup. Supported environment types such as ''kView'', ''kSQL'', ''kVMware'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter. ''kVMware'' indicates the VMware Protection Source environment. ''kHyperV'' indicates the HyperV Protection Source environment. ''kSQL'' indicates the SQL Protection Source environment. ''kView'' indicates the View Protection Source environment. ''kPuppeteer'' indicates the Cohesity''s Remote Adapter. ''kPhysical'' indicates the physical Protection Source environment. ''kPure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''kAzure'' indicates the Microsoft''s Azure Protection Source environment. ''kNetapp'' indicates the Netapp Protection Source environment. ''kAgent'' indicates the Agent Protection Source environment. ''kGenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''kAcropolis'' indicates the Acropolis Protection Source environment. ''kPhsicalFiles'' indicates the Physical Files Protection Source environment. ''kIsilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''kGPFS'' indicates IBM''s GPFS Protection Source environment. ''kKVM'' indicates the KVM Protection Source environment. ''kAWS'' indicates the AWS Protection Source environment. ''kExchange'' indicates the Exchange Protection Source environment. ''kHyperVVSS'' indicates the HyperV VSS Protection Source environment. ''kOracle'' indicates the Oracle Protection Source environment. ''kGCP'' indicates the Google Cloud Platform Protection Source environment. ''kFlashBlade'' indicates the Flash Blade Protection Source environment. ''kAWSNative'' indicates the AWS Native Protection Source environment. ''kO365'' indicates the Office 365 Protection Source environment. ''kO365Outlook'' indicates Office 365 outlook Protection Source environment. ''kHyperFlex'' indicates the Hyper Flex Protection Source environment. ''kGCPNative'' indicates the GCP Native Protection Source environment. ''kAzureNative'' indicates the Azure Native Protection Source environment. ''kKubernetes'' indicates a Kubernetes Protection Source environment. ''kElastifile'' indicates Elastifile Protection Source environment. ''kAD'' indicates Active Directory Protection Source environment. ''kRDSSnapshotManager'' indicates AWS RDS Protection Source environment. ''kCassandra'' indicates Cassandra Protection Source environment. ''kMongoDB'' indicates MongoDB Protection Source environment. ''kCouchbase'' indicates Couchbase Protection Source environment. ''kHdfs'' indicates Hdfs Protection Source environment. ''kHive'' indicates Hive Protection Source environment. ''kHBase'' indicates HBase Protection Source environment.' type: - string - 'null' enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kNimble - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kAzureNative - kKubernetes - kElastifile - kAD - kRDSSnapshotManager - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase x-go-name: Environment relativeSnapshotDirectory: description: 'Specifies the relative directory path from root path where the snapshot is stored.' type: - string - 'null' x-go-name: RelativeSnapshotDirectory rootPath: description: 'Specifies the root path where the snapshot is stored, using the following format: "/ViewBox/ViewName/fs".' type: - string - 'null' x-go-name: RootPath sourceSnapshotCreateTimeUsecs: description: 'Specifies the snapshot create time of the already created snapshot on the source' type: - integer - 'null' format: int64 x-go-name: SourceSnapshotCreateTimeUsecs sourceSnapshotName: description: 'Specifies the name of the snapshot backed up in a Netapp Data-Protect Volume where we use already created snapshot on the source' type: - string - 'null' x-go-name: SourceSnapshotName viewName: description: 'Specifies the name of the View that is cloned. NOTE: This field is only populated for View cloning.' type: - string - 'null' x-go-name: ViewName x-go-package: cohesity/iris/server/data/public FileLevelDataLockConfig: description: 'Specifies a config to lock files in a view - to protect from malicious or an accidental attempt to delete or modify the files in this view.' type: object title: File Level Data Lock Configurations. properties: autoLockAfterDurationIdle: description: 'Specifies the duration to lock a file that has not been accessed or modified (ie. has been idle) for a certain duration of time in milliseconds. Do not set if it is required to disable auto lock.' type: - integer - 'null' format: uint64 x-go-name: AutoLockAfterDurationIdleMsecs defaultFileRetentionDurationMsecs: description: 'Specifies a global default retention duration for files in this view, if file lock is enabled for this view. Also, it is a required field if file lock is enabled. Set to -1 if the required default retention period is forever.' type: - integer - 'null' format: int64 x-go-name: DefaultRetentionDurationMsecs expiryTimestampMsecs: description: Specifies a definite timestamp in milliseconds for retaining the file. type: - integer - 'null' format: uint64 x-go-name: ExpiryTimestampMsecs lockingProtocol: description: 'Specifies the supported mechanisms to explicity lock a file from NFS/SMB interface. Supported locking protocols: kSetReadOnly, kSetAtime. ''kSetReadOnly'' is compatible with Isilon/Netapp behaviour. This locks the file and the retention duration is determined in this order: 1) atime, if set by user/application and within min and max retention duration. 2) Min retention duration, if set. 3) Otherwise, file is switched to expired data automatically. ''kSetAtime'' is compatible with Data Domain behaviour.' type: - string - 'null' enum: - kSetReadOnly - kSetAtime x-go-name: LockingProtocol maxRetentionDurationMsecs: description: 'Specifies a maximum duration in milliseconds for which any file in this view can be retained for. Set to -1 if the required retention duration is forever. If set, it should be greater than or equal to the default retention period as well as the min retention period.' type: - integer - 'null' format: int64 x-go-name: MaxRetentionDurationMsecs minRetentionDurationMsecs: description: 'Specifies a minimum retention duration in milliseconds after a file gets locked. The file cannot be modified or deleted during this timeframe. Set to -1 if the required retention duration is forever. This should be set less than or equal to the default retention duration.' type: - integer - 'null' format: int64 x-go-name: MinRetentionDurationMsecs mode: description: 'Specifies the mode of file level datalock. Enterprise mode can be upgraded to Compliance mode, but Compliance mode cannot be downgraded to Enterprise mode. kCompliance: This mode would disallow all user to delete/modify file or view under any condition when it ''s in locked status except for deleting view when the view is empty. kEnterprise: This mode would follow the rules as compliance mode for normal users. But it would allow the storage admin (1) to delete view or file anytime no matter it is in locked status or expired. (2) to rename the view (3) to bring back the retention period when it''s in locked mode A lock mode of a file in a view can be in one of the following: ''kCompliance'': Default mode of datalock, in this mode, Data Security Admin cannot modify/delete this view when datalock is in effect. Data Security Admin can delete this view when datalock is expired. ''kEnterprise'' : In this mode, Data Security Admin can change view name or delete view when datalock is in effect. Datalock in this mode can be upgraded to ''kCompliance'' mode.' type: - string - 'null' enum: - kCompliance - kEnterprise x-go-name: Mode x-go-package: cohesity/iris/server/data/public FilePathFilter: description: 'Specifies filters to match files and directories on a Server. Two kinds of filters are supported. a) prefix which always starts with ''/''. b) posix which always starts with ''*'' (cannot be "*" only). Regular expressions are not supported. If a directory is matched, the action is applicable to all of its descendants. File paths not matching any protectFilters are not backed up. An example is: Protect Filters: "/" Exclude 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: File or Directory Path Filter. properties: excludeFilters: description: 'Array of Excluded File Path Filters. Specifies filters to match files or directories that should be removed from the list of objects matching ProtectFilters.' type: - array - 'null' items: type: string x-go-name: ExcludeFilters protectFilters: description: 'Array of Protected File Path Filters. Specifies filters to match files or directories that should be protected.' type: - array - 'null' items: type: string x-go-name: ProtectFilters x-go-package: cohesity/iris/server/data/public FleetNetworkParams: description: Specifies the various network params for the fleet. type: object title: Fleet Network Parameters. properties: region: description: Specifies the region for the fleet. type: - string - 'null' x-go-name: Region subnet: description: Specifies the subnet for the fleet. type: - string - 'null' x-go-name: Subnet vpc: description: Specifies the vpc for the fleet. type: - string - 'null' x-go-name: Vpc x-go-package: cohesity/iris/server/data/public VMwareProtectionSource: description: Specifies a Protection Source in a VMware environment. type: object title: VMware Protection Source. properties: agentId: description: Specifies the id of the persistent agent. type: - integer - 'null' format: int64 x-go-name: AgentId agents: description: 'Specifies the list of agent information on the Virtual Machine. This is set only if the Virtual Machine has persistent agent.' type: - array - 'null' items: $ref: '#/components/schemas/AgentInformation' x-go-name: Agents connectionState: description: 'Specifies the connection state of the Object and are only valid for ESXi hosts (''kHostSystem'') or Virtual Machines (''kVirtualMachine''). These enums are equivalent to the connection states documented in VMware''s reference documentation. Examples of Cohesity connection states include ''kConnected'', ''kDisconnected'', ''kInacccessible'', etc. ''kConnected'' indicates that server has access to virtual machine. ''kDisconnected'' indicates that server is currently disconnected to virtual machine. ''kInaccessible'' indicates that one or more configuration files are inacccessible. ''kInvalid'' indicates that virtual machine configuration is invalid. ''kOrphaned'' indicates that virtual machine is no longer registered on the host it is associated with. ''kNotResponding'' indicates that virtual machine has failed to respond due to external issues such as network connectivity, host not running etc.' type: - string - 'null' enum: - kConnected - kDisconnected - kInaccessible - kInvalid - kOrphaned - kNotResponding x-go-name: ConnectionState datastoreInfo: description: Specifies additional information of entities of type 'kDatastore'. $ref: '#/components/schemas/DatastoreInfo' folderType: description: 'Specifies the folder type for the ''kFolder'' Object. ''kVMFolder'' indicates folder can hold VMs or vApps. ''kHostFolder'' indicates folder can hold hosts and compute resources. ''kDatastoreFolder'' indicates folder can hold datastores and storage pods. ''kNetworkFolder'' indicates folder can hold networks and switches. ''kRootFolder'' indicates folder can hold datacenters.' type: - string - 'null' enum: - kVMFolder - kHostFolder - kDatastoreFolder - kNetworkFolder - kRootFolder x-go-name: FolderType hasPersistentAgent: description: 'Set to true if a persistent agent is running on the Virtual Machine. This is populated for entities of type ''kVirtualMachine''.' type: - boolean - 'null' x-go-name: HasPersistentAgent hostType: description: 'Specifies the host type for the ''kVirtualMachine'' Object. ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: HostType id: description: Specifies the UUID of the VMware Protection Source. $ref: '#/components/schemas/VMwareObjectId' ipDetails: description: This field can be used to capture IP Addresses for entities that have it. $ref: '#/components/schemas/IpDetails' isVmTemplate: description: IsTemplate specifies if the VM is a template or not. type: - boolean - 'null' x-go-name: IsVmTemplate name: description: Specifies a human readable name of the Protection Source. type: - string - 'null' x-go-name: Name tagAttributes: description: 'Specifies the optional list of VM Tag attributes associated with this Object.' type: - array - 'null' items: $ref: '#/components/schemas/TagAttribute' x-go-name: TagAttributes toolsRunningStatus: description: 'Specifies the status of VMware Tools for the guest OS on the VM. This is only valid for the ''kVirtualMachine'' type. ''kGuestToolsRunning'' means the VMware tools are running on the guest OS. ''kGuestToolsNotRunning'' means the VMware tools are not running on the guest OS. ''kUnknown'' means the state of the VMware tools on the guest OS is not known. ''kGuestToolsExecutingScripts'' means the guest OS is currently executing scripts using VMware tools.' type: - string - 'null' enum: - kUnknown - kGuestToolsExecutingScripts - kGuestToolsNotRunning - kGuestToolsRunning x-go-name: VMwareToolsRunningStatus type: description: 'Specifies the type of managed Object in a VMware Protection Source. Examples of VMware Objects include ''kVCenter'', ''kFolder'', ''kDatacenter'', ''kResourcePool'', ''kDatastore'', ''kVirtualMachine'', etc. ''kVCenter'' indicates the vCenter entity in a VMware protection source type. ''kFolder indicates the folder entity (of any kind) in a VMware protection source type. ''kDatacenter'' indicates the datacenter entity in a VMware protection source type. ''kComputeResource'' indicates the physical compute resource entity in a VMware protection source type. ''kResourcePool'' indicates the set of physical resources within a compute resource or cloudcompute resource. ''kDataStore'' indicates the datastore entity in a VMware protection source type. ''kHostSystem'' indicates the ESXi host entity in a VMware protection source type. ''kVirtualMachine'' indicates the virtual machine entity in a VMware protection source type. ''kVirtualApp'' indicates the virtual app entity in a VMware protection source type. ''kStandaloneHost'' indicates the standalone ESXi host entity (not managed by vCenter) in a VMware protection source type. ''kStoragePod'' indicates the storage pod entity in a VMware protection source type. ''kNetwork'' indicates the standard vSwitch in a VMware protection source type. ''kDistributedVirtualPortgroup'' indicates a distributed vSwitch port group in a VMware protection source type. ''kTagCategory'' indicates a tag category entity in a VMware protection source type. ''kTag'' indicates a tag entity in a VMware protection source type. ''kOpaqueNetwork'' indicates an opaque network which is created and managed by an entity outside of vSphere. ''kvCloudDirector'' indicates a vCloud director entity in a VMware protection source type. ''kOrganization'' indicates an Organization under a vCD in a VMware protection source type. ''kVirtualDatacenter'' indicates a virtual datacenter entity in a VMware protection source type. ''kCatalog'' indicates a VCD catalog entity in a VMware protection source type. ''kOrgMetadata'' indicates an VCD organization metadata in a VMware protection source type. ''kStoragePolicy'' indicates a storage policy associated with the vApp in a VMware protection source type.' type: - string - 'null' enum: - kVCenter - kFolder - kDatacenter - kComputeResource - kClusterComputeResource - kResourcePool - kDatastore - kHostSystem - kVirtualMachine - kVirtualApp - kStandaloneHost - kStoragePod - kNetwork - kDistributedVirtualPortgroup - kTagCategory - kTag - kOpaqueNetwork - kvCloudDirector - kOrganization - kVirtualDatacenter - kCatalog - kOrgMetadata - kStoragePolicy x-go-name: Type vCloudDirectorInfo: description: Specifies an array of vCenters to be registered type: - array - 'null' items: $ref: '#/components/schemas/VCloudDirectorInfo' x-go-name: VCloudDirectorInfo version: description: 'For vCenter and ESXi, this will show the software version. For VMs, this will show the hardware version.' type: - string - 'null' x-go-name: Version virtualDisks: description: 'Specifies an array of virtual disks that are part of the Virtual Machine. This is populated for entities of type ''kVirtualMachine''.' type: - array - 'null' items: $ref: '#/components/schemas/VirtualDiskInfo' x-go-name: VirtualDisks x-go-package: cohesity/iris/server/data/public ExchangeDatabaseInfo: description: Specifies the information about the Exchange Database. type: object title: Exchange Database Information properties: appServerId: description: 'Specifies the entity id of the Exchange Application Server which has this database copy.' type: - integer - 'null' format: int64 x-go-name: AppServerId backupSupported: description: Specifies if backup is supported for the Exchange database copy. type: - boolean - 'null' x-go-name: BackupSupported backupUnsupportedReasons: description: Specifies any reason(s) for Exchange database backup not supported. type: - array - 'null' items: type: string x-go-name: BackupUnsupportedReasons createdTimeMsecs: description: 'Specifies the time when the database is created in Unix epoch time in milliseconds.' type: - integer - 'null' format: int64 x-go-name: CreatedTimeMsecs databaseState: description: 'Specifies the state of the Exchange database copy. Specifies the state of Exchange Database Copy. ''kUnknown'' indicates the status is not known. ''kMounted'' indicates the exchange database copy is mounted and healthy. ''kError'' indicates the exchange database copy is unmounted or partially mounted or is in error state.' type: - string - 'null' enum: - kUnknown - kMounted - kError x-go-name: DatabaseState dbSizeBytes: description: Specifies the size of the Exchange database copy in bytes. type: - integer - 'null' format: int64 x-go-name: DbSizeBytes dbguid: description: Specifies the guid of the Exchange Database. type: - string - 'null' x-go-name: DbGuid name: description: Specifes the name of the Exchange Database. type: - string - 'null' x-go-name: Name ownerId: description: 'Specifies the owner entity id of the Exchange Application Server which has this database copy.' type: - integer - 'null' format: int64 x-go-name: OwnerId utcOffsetMin: description: Specifies UTC time offset of database creation time. type: - integer - 'null' format: int64 x-go-name: UtcOffsetMin x-go-package: cohesity/iris/server/data/public SqlEnvJobParameters: description: 'Specifies job parameters applicable for all ''kSQL'' Environment type Protection Sources in a Protection Job.' type: object title: SQL Environment Job Parameters. properties: aagPreference: description: 'Specifies the preference for backing up databases that are part of an AAG. Only applicable if ''aagPreferenceFromSqlServer'' is set to false or not given. kPrimaryReplicaOnly implies backups should always occur on the primary replica. kSecondaryReplicaOnly implies backups should always occur on the secondary replica. kPreferSecondaryReplica implies secondary replica is preferred for backups. kAnyReplica implies no preference of about whether backups are performed on the primary replica or on a secondary replica. If no secondary replica is available, then performing backups on the primary replica is acceptable.' type: - string - 'null' enum: - kPrimaryReplicaOnly - kSecondaryReplicaOnly - kPreferSecondaryReplica - kAnyReplica x-go-name: AagPreference aagPreferenceFromSqlServer: description: 'If true, AAG preferences are taken from the SQL server host. If this is set to false or not given, preferences can be overridden by aagBackupPreference.' type: - boolean - 'null' x-go-name: AagPreferenceFromSqlServer backupSystemDatabases: description: 'If true, system databases are backed up. If this is set to false, system databases are not backed up. If this field is not specified, default value is true.' type: - boolean - 'null' x-go-name: BackupSystemDatabases backupType: description: 'Specifies the type of the ''kFull'' backup job. Specifies whether it is Volume level backup or individual files level backup. kSqlVSSVolume implies volume based VSS full backup. kSqlVSSFile implies file based VSS full backup.' type: - string - 'null' enum: - kSqlVSSVolume - kSqlVSSFile - kSqlNative x-go-name: BackupType backupVolumesOnly: 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: BackupVolumesOnly incrementalSnapshotUponRestart: description: 'If true, the backup of type kSqlVssVolume will be incremental after restart' type: - boolean - 'null' x-go-name: IncrementalSnapshotUponRestart isCopyOnlyFull: description: If true, the backup is a full backup with the copy-only option specified. type: - boolean - 'null' x-go-name: IsCopyOnlyFull numStreams: description: Number of streams to be used in native sql backup. type: - integer - 'null' format: int32 x-go-name: NumStreams userDatabasePreference: description: 'Specifies the preference for backing up user databases on the host. kBackupAllDatabases implies to backup all databases. kBackupAllExceptAAGDatabases implies not to backup AAG databases. kBackupOnlyAAGDatabases implies to backup only AAG databases.' type: - string - 'null' enum: - kBackupAllDatabases - kBackupAllExceptAAGDatabases - kBackupOnlyAAGDatabases x-go-name: UserDatabasePreference withClause: description: With clause is used for setting clauese in native sql backup. type: - string - 'null' x-go-name: WithClause x-go-package: cohesity/iris/server/data/public LatencyThresholds: description: 'Specifies latency thresholds that trigger throttling for all datastores found in the registered Protection Source or specific to one datastore.' type: object title: Latency Thresholds. properties: activeTaskMsecs: description: 'If the latency of a datastore is above this value, existing backup tasks using the datastore are throttled.' type: - integer - 'null' format: int64 x-go-name: ActiveTaskMsecs newTaskMsecs: description: 'If the latency of a datastore is above this value, then new backup tasks using the datastore will not be started.' type: - integer - 'null' format: int64 x-go-name: NewTaskMsecs x-go-package: cohesity/iris/server/data/public RegisterProtectionSourceParameters: description: Specifies the parameters required to register a Protection Source. type: object title: Register Protection Source Parameters. properties: acropolisType: description: 'Specifies the entity type if the environment is kAcropolis. overrideDescription: true' type: - string - 'null' enum: - kStandaloneCluster x-go-name: AcropolisType agentEndpoint: description: Specifies the agent endpoint if it is different from the source endpoint. type: - string - 'null' x-go-name: AgentEndpoint awsCredentials: description: Specifies credentials needed to authenticate with AWS Cloud Platform. title: AWS Source Credentials. $ref: '#/components/schemas/AwsCredentials' awsFleetParams: description: 'Specifies information related to AWS fleets launched for various purposes. This will only be set for kIAMUser entity.' $ref: '#/components/schemas/AwsFleetParams' azureCredentials: description: Specifies credentials needed to authenticate with Azure Cloud Platform. title: Azure Source Credentials. $ref: '#/components/schemas/AzureCredentials' blacklistedIpAddresses: description: 'Specifies the list of IP Addresses on the registered source to be blacklisted for doing any type of IO operations.' type: - array - 'null' items: type: string x-go-name: BlacklistedIpAddresses clusterNetworkInfo: description: 'Specifies information related to cluster. This is only valid for CE clusters. This is only populated for kIAMUser entity.' $ref: '#/components/schemas/FleetNetworkParams' endpoint: description: 'Specifies the network endpoint of the Protection Source where it is reachable. It could be an URL or hostname or an IP address of the Protection Source.' type: - string - 'null' x-go-name: Endpoint environment: description: 'Specifies the environment such as ''kPhysical'' or ''kVMware'' of the Protection Source. overrideDescription: true Supported environment types such as ''kView'', ''kSQL'', ''kVMware'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter. ''kVMware'' indicates the VMware Protection Source environment. ''kHyperV'' indicates the HyperV Protection Source environment. ''kSQL'' indicates the SQL Protection Source environment. ''kView'' indicates the View Protection Source environment. ''kPuppeteer'' indicates the Cohesity''s Remote Adapter. ''kPhysical'' indicates the physical Protection Source environment. ''kPure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''kAzure'' indicates the Microsoft''s Azure Protection Source environment. ''kNetapp'' indicates the Netapp Protection Source environment. ''kAgent'' indicates the Agent Protection Source environment. ''kGenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''kAcropolis'' indicates the Acropolis Protection Source environment. ''kPhsicalFiles'' indicates the Physical Files Protection Source environment. ''kIsilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''kGPFS'' indicates IBM''s GPFS Protection Source environment. ''kKVM'' indicates the KVM Protection Source environment. ''kAWS'' indicates the AWS Protection Source environment. ''kExchange'' indicates the Exchange Protection Source environment. ''kHyperVVSS'' indicates the HyperV VSS Protection Source environment. ''kOracle'' indicates the Oracle Protection Source environment. ''kGCP'' indicates the Google Cloud Platform Protection Source environment. ''kFlashBlade'' indicates the Flash Blade Protection Source environment. ''kAWSNative'' indicates the AWS Native Protection Source environment. ''kO365'' indicates the Office 365 Protection Source environment. ''kO365Outlook'' indicates Office 365 outlook Protection Source environment. ''kHyperFlex'' indicates the Hyper Flex Protection Source environment. ''kGCPNative'' indicates the GCP Native Protection Source environment. ''kAzureNative'' indicates the Azure Native Protection Source environment. ''kKubernetes'' indicates a Kubernetes Protection Source environment. ''kElastifile'' indicates Elastifile Protection Source environment. ''kAD'' indicates Active Directory Protection Source environment. ''kRDSSnapshotManager'' indicates AWS RDS Protection Source environment. ''kCassandra'' indicates Cassandra Protection Source environment. ''kMongoDB'' indicates MongoDB Protection Source environment. ''kCouchbase'' indicates Couchbase Protection Source environment. ''kHdfs'' indicates Hdfs Protection Source environment. ''kHive'' indicates Hive Protection Source environment. ''kHBase'' indicates HBase Protection Source environment.' type: - string - 'null' enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kNimble - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kAzureNative - kKubernetes - kElastifile - kAD - kRDSSnapshotManager - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase x-go-name: Environment exchangeDagProtectionPreference: description: 'Specifies information about the preference order while choosing between which database copy of the exchange database which is part of DAG should be protected.' $ref: '#/components/schemas/ExchangeDAGProtectionPreference' forceRegister: description: 'ForceRegister is applicable to Physical Environment. By default, the agent running on a physical host will fail the registration, if it is already registered as part of another cluster. By setting this option to true, agent can be forced to register with the current cluster. This is a hidden parameter and should not be documented externally.' type: - boolean - 'null' x-go-name: ForceRegister gcpCredentials: description: Specifies credentials needed to authenticate with Google Cloud Platform. title: GCP Source Credentials. $ref: '#/components/schemas/GcpCredentials' hostType: description: 'Specifies the optional OS type of the Protection Source (such as kWindows or kLinux). overrideDescription: true ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: HostType hyperVType: description: 'Specifies the entity type if the environment is kHyperV. overrideDescription: true' type: - string - 'null' enum: - kSCVMMServer - kStandaloneHost - kStandaloneCluster x-go-name: HyperVType kubernetesCredentials: description: Specifies the credentials needed to authenticate a Kubernetes cluster. title: Kubernetes Source Credentials. $ref: '#/components/schemas/KubernetesCredentials' kubernetesType: description: 'Specifies the entity type if the environment is kKubernetes. overrideDescription: true' type: - string - 'null' enum: - kCluster x-go-name: KubernetesType kvmType: description: 'Specifies the entity type if the environment is kKVM. overrideDescription: true' type: - string - 'null' enum: - kOVirtManager x-go-name: KvmType nasMountCredentials: description: 'Specifies the server credentials to connect to a NetApp server. This field is required for mounting SMB volumes on NetApp servers.' title: NAS Server Credentials. allOf: - $ref: '#/components/schemas/NasMountCredentialParams' netappType: description: 'Specifies the entity type such as ''kCluster,'' if the environment is kNetapp.' type: - string - 'null' enum: - kCluster - kVserver x-go-name: NetappType nimbleType: description: 'Specifies the entity type such as ''kStorageArray'' if the environment is kNimble. overrideDescription: true' type: - string - 'null' enum: - kStorageArray x-go-name: NimbleType office365CredentialsList: description: 'Office365 Source Credentials. Specifies credentials needed to authenticate & authorize user for Office365 using MS Graph APIs.' type: - array - 'null' items: $ref: '#/components/schemas/Office365Credentials' x-go-name: Office365CredentialsList office365Region: description: Specifies the region for Office365. type: - string - 'null' x-go-name: Office365Region office365Type: description: 'Specifies the entity type such as ''kDomain'', ''kOutlook'', ''kMailbox'', if the environment is kO365.' type: - string - 'null' enum: - kDomain x-go-name: Office365Type password: description: Specifies password of the username to access the target source. type: - string - 'null' x-go-name: Password physicalType: description: 'Specifies the entity type such as ''kPhysicalHost'' if the environment is kPhysical. overrideDescription: true' type: - string - 'null' enum: - kHost x-go-name: PhysicalType pureType: description: 'Specifies the entity type such as ''kStorageArray'' if the environment is kPure. overrideDescription: true' type: - string - 'null' enum: - kStorageArray x-go-name: PureType reRegister: description: 'ReRegister is applicable to Physical Environment. By default, the agent running on a physical host will fail the registration, if it is already registered with the cluster. By setting this option to true, agent can be re-registered with the current cluster.' type: - boolean - 'null' x-go-name: ReRegister sourceSideDedupEnabled: description: 'This controls whether to use source side dedup on the source or not. This is only applicable to sources which support source side dedup (e.g., Linux physical servers).' type: - boolean - 'null' x-go-name: SourceSideDedupEnabled sslVerification: description: 'SSL verification parameter is applicable to VMware environment. It can be populated with the server''s CA certificate or certificate chain and vCenter''s certificate will be validated against this.' $ref: '#/components/schemas/SslVerification' subnets: description: 'Specifies the list of subnet IP addresses and CIDR prefix for enabeling network data transfer. Currently, only Subnet IP and NetbaskBits are valid input fields. All other fields provided as input will be ignored.' type: - array - 'null' items: $ref: '#/components/schemas/Subnet' x-go-name: Subnets throttlingPolicy: description: Specifies the throttling policy that should be applied to this Source. allOf: - $ref: '#/components/schemas/ThrottlingPolicyParameters' throttlingPolicyOverrides: description: 'Array of Throttling Policy Overrides for Datastores. Specifies a list of Throttling Policy for datastores that override the common throttling policy specified for the registered Protection Source. For datastores not in this list, common policy will still apply.' type: - array - 'null' items: $ref: '#/components/schemas/ThrottlingPolicyOverride' x-go-name: ThrottlingPolicyOverrides useOAuthForExchangeOnline: description: 'Specifies whether OAuth should be used for authentication in case of Exchange Online.' type: - boolean - 'null' x-go-name: UseOAuthForExchangeOnline username: description: Specifies username to access the target source. type: - string - 'null' x-go-name: Username vlanParams: description: 'Specifies the VLAN parameters to be used while taking the backup of this entity and is the preferred selection for restoring the same. For restores, the VLAN parameters specifed here can be overridden. Currently, this is only applicable for Physical hosts running Oracle.' $ref: '#/components/schemas/VlanParameters' vmwareType: description: 'Specifies the entity type such as ''kVCenter'' if the environment is kKMware. overrideDescription: true' type: - string - 'null' enum: - kVCenter - kStandaloneHost - kvCloudDirector x-go-name: VMwareType x-go-package: cohesity/iris/server/data/public HBaseTable: description: Specifies an Object containing information about a HBase table. type: object title: HBase Table Info. properties: approxSizeBytes: description: Specifies the approx size of the table in bytes. type: - integer - 'null' format: int64 x-go-name: ApproxSizeBytes x-go-package: cohesity/iris/server/data/public HBaseConnectParams: description: 'Specifies an Object containing information about a registered HBase source.' type: object title: HBase Connect Params. properties: hdfsEntityId: description: The entity id of the HDFS source for this HBase type: - integer - 'null' format: int64 x-go-name: HdfsEntityId kerberosPrincipal: description: Specifies the kerberos principal. type: - string - 'null' x-go-name: KerberosPrincipal rootDataDirectory: description: Specifies the HBase data root directory. type: - string - 'null' x-go-name: RootDataDirectory zookeeperQuorum: description: Specifies the HBase zookeeper quorum. type: - array - 'null' items: type: string x-go-name: ZookeeperQuorum x-go-package: cohesity/iris/server/data/public OracleDataGuardInfo: description: 'Specifies information about the Database in Oracle DataGuard configuration. Data GUard provides a comprehensive set of services that create, maintain, and monitor one or more standby databases to enable production Oracle databases to survive disasters and data corruptions. Data Guard maintains these standby databases as transactionally consistent copies of the production databases.' type: object title: Oracle Data Guard Configuration Info. properties: role: description: 'Specifies the role of the DataGuard database. Specifies the role of the DataGuard database. A Data Guard configuration contains one production database, also referred to as the primary database, that functions in the primary role. The primary database can be either a single-instance Oracle database or an Oracle Real Application Clusters database. A standby database is a transactionally consistent copy of the primary database. Similar to a primary database, a standby database can be either a single-instance Oracle database or an Oracle Real Application Clusters database. ''kPrimary'' indicates that the current database is primary database. ''kStandby'' indicates that the current database is standby database.' type: - string - 'null' enum: - kPrimary - kStandby x-go-name: Role type: description: 'Specifies the type of standby database. Specifies the type of standby database. ''kPhysical'' indicates that the current database provides a physically identical copy of the primary database, with on disk structures identical to the primary database on a block-for-block basis. It is kept synchronized with the primary database, though Redo Apply, which recovers the redo data received from the primary database and applies the redo to the physical standby database. ''kLogical'' indicates that the current database provides the same logical information as the production database, although the physical structure can be different. It is kept synchronized with the primary database thorugh SQL Apply, which transforms the data in the redo received from the primary database into SQL statements and then executing the SQL statements on the standby database. ''kSnapshot'' indicates that the current database is a fully updateable standby created by converting a physical standby database into a snasphot standby database. It receives and archives but does not apply redo data from a primary database.' type: - string - 'null' enum: - kPhysical - kLogical - kSnapshot x-go-name: Type x-go-package: cohesity/iris/server/data/public BackupScript: description: 'Specifies details about the pre and post backup scripts for ''kPhysical'' jobs.' type: object title: Backup Script. properties: fullBackupScript: description: 'Specifies the script that should run for the Full (no CBT) backup schedule of a Remote Adapter ''kPuppeteer'' Job. This field is mandatory if the Policy associated with this Job has a Full (no CBT) backup schedule and this is Remote Adapter ''kPuppeteer'' Job.' title: Full (No CBT) Script. allOf: - $ref: '#/components/schemas/RemoteScriptPathAndParams' incrementalBackupScript: description: 'Specifies the script that should run for the CBT-based backup schedule of a Remote Adapter ''kPuppeteer'' Job. A CBT-based backup schedule is utilizing Change Block Tracking when capturing Snapshots. This field is mandatory if the Policy associated with this Job has a CBT-based backup schedule and this is Remote Adapter ''kPuppeteer'' Job.' title: CBT-based Script. allOf: - $ref: '#/components/schemas/RemoteScriptPathAndParams' logBackupScript: description: 'Specifies the script that should run for the Log backup schedule of a Remote Adapter ''kPuppeteer'' Job. This field is mandatory if the Policy associated with this Job has a Log backup schedule and this is Remote Adapter ''kPuppeteer'' Job.' title: Log Script. allOf: - $ref: '#/components/schemas/RemoteScriptPathAndParams' remoteHost: description: 'Specifies the remote host where the remote scripts are executed. This field must be set for Remote Adapter Jobs.' allOf: - $ref: '#/components/schemas/RemoteHost' username: description: 'Specifies the username that will be used to login to the remote host. For host type ''kLinux'', it is expected that user has setup the password-less access. So only username field is required.' type: - string - 'null' x-go-name: Username x-go-package: cohesity/iris/server/data/public RunDiagnosticsMessage: description: Specifies the status of an Run Diagnostics request. type: object title: Status of Run Diagnostics Request. properties: message: description: 'Specifies the status message returned after initiating a run diagnostics request.' type: - string - 'null' x-go-name: Message x-go-package: cohesity/iris/server/data/public UpgradePhysicalServerAgents: description: 'Specifies a request to upgrade the Cohesity agents on one or more Physical Servers registered on the Cohesity Cluster.' type: object title: Upgrade Physical Server Agents Request. required: - agentIds properties: agentIds: description: 'Array of Agent Ids. Specifies a list of agentIds associated with the Physical Servers to upgrade with the agent release currently available from the Cohesity Cluster.' type: - array - 'null' items: type: integer format: int64 x-go-name: AgentIds x-go-package: cohesity/iris/server/data/public MongoDBDatabase: description: Specifies an Object containing information about a mongodb database. type: object title: MongoDB Database Info. properties: sizeBytes: description: Size of this Database. type: - integer - 'null' format: int64 x-go-name: SizeBytes x-go-package: cohesity/iris/server/data/public DataUptierJobParameters: type: object title: Data Uptier Job Parameters. properties: fileSelectionPolicy: description: 'Specifies policy to select a file to uptier based on file access or modification time. eg. A file can be selected to uptier if it has been accessed in the HotFileWindow or it is modified. enum: kLastAccessed, kLastModified. Specifies policy for file selection in data uptier jobs. ''kLastAccessed'': Uptier the files which are accessed for at least num_file_access in hot_file_window. ''kLastModified'': Uptier the files which are modified.' type: - string - 'null' enum: - kLastAccessed - kLastModified x-go-name: FileUptierSelectionPolicy fileSizeBytes: description: 'Gives the size criteria to be used for selecting the files to be uptiered in bytes. The hot files that are smaller or greater than this size are uptiered.' type: - integer - 'null' format: int64 x-go-name: FileSizeBytes fileSizePolicy: description: 'Specifies policy to select a file to uptier based on its size. eg. A file can be selected to uptier if its size is greater than or smaller than the FileSizeBytes. enum: kGreaterThan, kSmallerThan. Specifies policy for file selection in data uptier jobs based on file size. ''kGreaterThan'': Uptier the files having size greater than file_size. ''kSmallerThan'': Uptier the files having size smaller than file_size.' type: - string - 'null' enum: - kGreaterThan - kSmallerThan x-go-name: FileUptierSizePolicy hotFileWindow: description: 'Identifies the hot files in the NAS source. Files that have been modified in the last hot_file_window are uptiered. Applicable only when file_select_policy is kLastAccessed.' type: - integer - 'null' format: int64 x-go-name: HotFileWindow includeAllFiles: description: 'Specifies whether uptier all files found in the view by overriding the FileUptierSelectionPolicy & FileUptierSizePolicy constraints. Default value false.' type: - boolean - 'null' x-go-name: IncludeAllFiles 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 x-go-package: cohesity/iris/server/data/public GetRegistrationInfoResponse: description: 'Specifies the registration, protection and permission information of all or a subset of the registered Protection Source Trees or Views on the Cohesity Cluster.' type: object title: Get Registration Information Response. properties: rootNodes: description: 'Specifies the registration, protection and permission information of either all or a subset of registered Protection Sources matching the filter parameters. overrideDescription: true' type: - array - 'null' items: $ref: '#/components/schemas/ProtectionSourceTreeInfo' x-go-name: RootNodes stats: description: 'Specifies the sum of all the stats of protection of Protection Sources and views selected by the query parameters.' allOf: - $ref: '#/components/schemas/ProtectionSummary' statsByEnv: description: 'Specifies the breakdown of the stats by environment overrideDescription: true' type: - array - 'null' items: $ref: '#/components/schemas/ProtectionSummaryByEnv' x-go-name: StatsByEnv x-go-package: cohesity/iris/server/data/public AwsSnapshotManagerParameters: description: 'Protection Job parameters applicable to ''kAWSSnapshotManager'' Environment type. Specifies additional job parameters applicable for ''kAWSSnapshotManager'' Environment type Protection Sources in a Protection Job.' type: object title: AWS SnapshotManager Parameters. properties: amiCreationFrequency: description: 'Specifies 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 createAmi: description: 'If true, creates an AMI after taking snapshots of the instance. It should be set only while backing up EC2 instances. CreateAmi creates AMI for the protection job.' type: - boolean - 'null' x-go-name: CreateAmi x-go-package: cohesity/iris/server/data/public AlertingConfig: description: Specifies optional settings for alerting. type: object title: Alerting Config. properties: emailAddresses: description: Exists to maintain backwards compatibility with versions before eff8198. type: - array - 'null' items: type: string x-go-name: EmailAddresses emailDeliveryTargets: description: 'Specifies additional email addresses where alert notifications (configured in the AlertingPolicy) must be sent.' type: - array - 'null' items: $ref: '#/components/schemas/EmailDeliveryTarget' x-go-name: EmailDeliveryTargets raiseObjectLevelFailureAlert: description: Specifies the boolean to raise per object alert for failures. type: - boolean - 'null' x-go-name: RaiseObjectLevelFailureAlert x-go-package: cohesity/iris/server/data/public IsilonMountPoint: description: Specifies information about a mount point in an Isilon OneFs Cluster. type: object title: Isilon Mount Point. properties: accessZoneName: description: Specifies the name of access zone. type: - string - 'null' x-go-name: AccessZoneName nfsMountPoint: description: 'Specifies information about an NFS export. This field is set if the file system supports protocol type ''kNfs''.' $ref: '#/components/schemas/IsilonNfsMountPoint' path: description: 'Specifies the path of the access zone in ifs. This should include the leading "/ifs/".' type: - string - 'null' x-go-name: Path protocols: description: 'List of Protocols on Isilon. Specifies the list of protocols enabled on Isilon OneFs file system. ''kNfs'' indicates NFS exports in an Isilon Cluster. ''kSmb'' indicates CIFS/SMB Shares in an Isilon Cluster.' type: - array - 'null' items: type: string enum: - kNfs - kSmb x-go-name: Protocols smbMountPoints: description: 'Specifies information about an SMB share. This field is set if the file system supports protocol type ''kSmb''.' type: - array - 'null' items: $ref: '#/components/schemas/IsilonSmbMountPoint' x-go-name: SmbMountPoints x-go-package: cohesity/iris/server/data/public AwsFleetParams: description: Specifies various resources when deploying a VM to Fleet instances. type: object title: AWS Fleet Parameters. properties: fleetSubnetType: description: 'Specifies the subnet type of the fleet. Specifies the type of the fleet subnet. ''kCluster'' implies same subnet as of Cluster, valid only for Cloud Edition cluster. ''kSourceVM'' implies same subnet as of source vm. ''kCustom'' implies the custome subnet.' type: - string - 'null' enum: - kCluster - kSourceVM - kCustom x-go-name: FleetSubnetType fleetTags: description: Specifies the tag information for the fleet. type: - array - 'null' items: $ref: '#/components/schemas/FleetTag' x-go-name: FleetTags networkParamsList: description: Specifies the list of network params for the fleet. type: - array - 'null' items: $ref: '#/components/schemas/FleetNetworkParams' x-go-name: NetworkParamsList x-go-package: cohesity/iris/server/data/public ExchangeHostInfo: description: Specifies the Information about the Exchange host. type: object title: Exchange Host Info properties: agentStatus: description: 'Specifies the status of the agent on the Exchange host. Specifies the status of agent on Exchange Application Server. ''kSupported'' indicates the agent is supported for Exchange data protection. ''kUnSupported'' indicates the agent is not supported for Exchange data protection. ''kUpgrade'' indicates the agent of server need to be upgraded.' type: - string - 'null' enum: - kSupported - kUpgrade - kUnsupported x-go-name: AgentStatus endpoint: description: Specifies the endpoint of the Exchange host. type: - string - 'null' x-go-name: Endpoint guid: description: Specifies the guid of the Exchange host. type: - string - 'null' x-go-name: Guid name: description: Specifies the display name of the Exchange host. type: - string - 'null' x-go-name: Name protectionSourceId: description: 'Specifies the Protection source id of the Physical Host if the Exchange application is already registered on the physical host with the above endpoint.' type: - integer - 'null' format: int64 x-go-name: ProtectionSourceId status: description: 'Specifies the status of the registration of the Exchange Host. Specifies the status of registration of Exchange Application Server. ''kUnknown'' indicates the status is not known. ''kHealthy'' indicates the status is healty and is registered as Exchange Server. ''kUnHealthy'' indicates the exchange application is registered on the physical server but it is unreachable now. ''kUnregistered'' indicates the server is not registered as physical source. ''kUnreachable'' indicates the server is not reachable from the cohesity cluster or the cohesity protection server is not installed on the exchange server. ''kDetached'' indicates the server is removed from the ExchangeDAG.' type: - string - 'null' enum: - kUnknown - kHealthy - kUnHealthy - kUnregistered - kUreachable - kDetached x-go-name: Status x-go-package: cohesity/iris/server/data/public ProtectionJob: description: Provides details about a Protection Job. type: object title: Protection Job. required: - name - policyId - viewBoxId - sourceSpecialParameters properties: LeverageSanTransport: description: 'If this field is set to true, then the backup for the objects will be performed using dedicated storage area network (SAN) instead of LAN or managment network.' type: - boolean - 'null' abortInBlackoutPeriod: description: 'If true, the Cohesity Cluster aborts any currently executing Job Runs of this Protection Job when a blackout period specified for this Job starts, even if the Job Run started before the blackout period began. If false, a Job Run continues to execute, if the Job Run started before the blackout period starts.' type: - boolean - 'null' x-go-name: AbortInBlackoutPeriod alertingConfig: description: 'Alerting configuration can be used to specify optional details for the alerts triggered by this job.' $ref: '#/components/schemas/AlertingConfig' alertingPolicy: description: 'Array of Job Events. During Job Runs, the following Job Events are generated: 1) Job succeeds 2) Job fails 3) Job violates the SLA These Job Events can cause Alerts to be generated. ''kSuccess'' means the Protection Job succeeded. ''kFailure'' means the Protection Job failed. ''kSlaViolation'' means the Protection Job took longer than the time period specified in the SLA.' type: - array - 'null' items: type: string enum: - kSuccess - kFailure - kSlaViolation x-go-name: AlertingPolicy cloudParameters: description: Specifies Cloud specific parameters applicable in various scenarios. $ref: '#/components/schemas/CloudParameters' continueOnQuiesceFailure: description: Whether to continue backing up on quiesce failure. type: - boolean - 'null' x-go-name: ContinueOnQuiesceFailure createRemoteView: description: Specifies whether to create a remote view name to use for view overwrite. type: - boolean - 'null' x-go-name: CreateRemoteView creationTimeUsecs: description: Specifies the time when the Protection Job was created. type: - integer - 'null' format: int64 x-go-name: CreationTimeUsecs dataMigrationPolicy: description: 'Specifies policy for a data migration job. It contains inline schedule to run the data migration job. In addition to this, it also contains retention policy that should be applied to files after they have been moved to cohesity cluster. It is present only in case data migration job.' $ref: '#/components/schemas/DataMigrationPolicy' dedupDisabledSourceIds: 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: DedupDisabledSourceIds description: description: Specifies a text description about the Protection Job. type: - string - 'null' x-go-name: Description endTimeUsecs: description: 'Specifies the epoch time (in microseconds) after which the Protection Job becomes dormant.' type: - integer - 'null' format: int64 x-go-name: EndTimeUsecs environment: description: 'Specifies the environment type (such as kVMware or kSQL) of the Protection Source this Job is protecting. Supported environment types such as ''kView'', ''kSQL'', ''kVMware'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter. ''kVMware'' indicates the VMware Protection Source environment. ''kHyperV'' indicates the HyperV Protection Source environment. ''kSQL'' indicates the SQL Protection Source environment. ''kView'' indicates the View Protection Source environment. ''kPuppeteer'' indicates the Cohesity''s Remote Adapter. ''kPhysical'' indicates the physical Protection Source environment. ''kPure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''kAzure'' indicates the Microsoft''s Azure Protection Source environment. ''kNetapp'' indicates the Netapp Protection Source environment. ''kAgent'' indicates the Agent Protection Source environment. ''kGenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''kAcropolis'' indicates the Acropolis Protection Source environment. ''kPhsicalFiles'' indicates the Physical Files Protection Source environment. ''kIsilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''kGPFS'' indicates IBM''s GPFS Protection Source environment. ''kKVM'' indicates the KVM Protection Source environment. ''kAWS'' indicates the AWS Protection Source environment. ''kExchange'' indicates the Exchange Protection Source environment. ''kHyperVVSS'' indicates the HyperV VSS Protection Source environment. ''kOracle'' indicates the Oracle Protection Source environment. ''kGCP'' indicates the Google Cloud Platform Protection Source environment. ''kFlashBlade'' indicates the Flash Blade Protection Source environment. ''kAWSNative'' indicates the AWS Native Protection Source environment. ''kO365'' indicates the Office 365 Protection Source environment. ''kO365Outlook'' indicates Office 365 outlook Protection Source environment. ''kHyperFlex'' indicates the Hyper Flex Protection Source environment. ''kGCPNative'' indicates the GCP Native Protection Source environment. ''kAzureNative'' indicates the Azure Native Protection Source environment. ''kKubernetes'' indicates a Kubernetes Protection Source environment. ''kElastifile'' indicates Elastifile Protection Source environment. ''kAD'' indicates Active Directory Protection Source environment. ''kRDSSnapshotManager'' indicates AWS RDS Protection Source environment. ''kCassandra'' indicates Cassandra Protection Source environment. ''kMongoDB'' indicates MongoDB Protection Source environment. ''kCouchbase'' indicates Couchbase Protection Source environment. ''kHdfs'' indicates Hdfs Protection Source environment. ''kHive'' indicates Hive Protection Source environment. ''kHBase'' indicates HBase Protection Source environment.' type: - string - 'null' enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kNimble - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kAzureNative - kKubernetes - kElastifile - kAD - kRDSSnapshotManager - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase x-go-name: Environment environmentParameters: description: 'Specifies additional settings that are applicable to all Sources in the Protection Job that are of specified environment type. For example, you can specify to exclude a disk from backup for all ''kVMware'' Protection Sources in the Protection Job. If a setting conflicts with sourceSpecialParameters, then sourceSpecialParameters will be used.' $ref: '#/components/schemas/EnvironmentTypeJobParameters' excludeSourceIds: description: 'Array of Excluded Source Objects. List of Object ids from a Protection Source that should not be protected and are excluded from being backed up by the Protection Job. Leaf and non-leaf Objects may be in this list and an Object in this list must have an ancestor in the sourceId list.' type: - array - 'null' items: type: integer format: int64 x-go-name: ExcludeSourceIds excludeVmTagIds: description: 'Array of Arrays of VM Tag Ids that Specify VMs to Exclude. Optionally specify a list of VMs to exclude from protecting by listing Protection Source ids of VM Tags in this two dimensional array. Using this two dimensional array of Tag ids, the Cluster generates a list of VMs to exclude from protecting, which are derived from intersections of the inner arrays and union of the outer array, as shown by the following example. For example a Datacenter is selected to be protected but you want to exclude all the ''Former Employees'' VMs in the East and West but keep all the VMs for ''Former Employees'' in the South which are also stored in this Datacenter, by specifying the following tag id array: [ [1000, 2221], [1000, 3031] ], where 1000 is the ''Former Employee'' VM Tag id, 2221 is the ''East'' VM Tag id and 3031 is the ''West'' VM Tag id. The first inner array [1000, 2221] produces a list of VMs that are both tagged with ''Former Employees'' and ''East'' (an intersection). The second inner array [1000, 3031] produces a list of VMs that are both tagged with ''Former Employees'' and ''West'' (an intersection). The outer array combines the list of VMs from the two inner arrays. The list of resulting VMs are excluded from being protected this Job.' type: - array - 'null' items: type: array items: type: integer format: int64 x-go-name: ExcludeVmTagIds fullProtectionSlaTimeMins: description: 'If specified, this setting is number of minutes that a Job Run of a Full (no CBT) backup schedule is expected to complete, which is known as a Service-Level Agreement (SLA). A SLA violation is reported when the run time of a Job Run exceeds the SLA time period specified for this backup schedule.' type: - integer - 'null' format: int64 x-go-name: FullProtectionSlaTimeMins fullProtectionStartTime: description: 'Specifies the time of day to start the Full Protection Schedule. This is optional and only applicable if the Protection Policy defines a monthly or a daily Full (no CBT) Protection Schedule. Default value is 02:00 AM. deprecated: true' title: Full (no CBT) Protection Schedule Start Time. allOf: - $ref: '#/components/schemas/TimeOfDay' id: description: Specifies an id for the Protection Job. type: - integer - 'null' format: int64 x-go-name: Id incrementalProtectionSlaTimeMins: description: 'If specified, this setting is number of minutes that a Job Run of a CBT-based backup schedule is expected to complete, which is known as a Service-Level Agreement (SLA). A SLA violation is reported when the run time of a Job Run exceeds the SLA time period specified for this backup schedule.' type: - integer - 'null' format: int64 x-go-name: IncrementalProtectionSlaTimeMins incrementalProtectionStartTime: description: 'Specifies the time of day to start the CBT-based Protection Schedule. This is optional and only applicable if the Protection Policy defines a monthly or a daily CBT-based Protection Schedule. Default value is 02:00 AM. deprecated: true' title: CBT-based Protection Schedule Start Time. allOf: - $ref: '#/components/schemas/TimeOfDay' indexingPolicy: description: 'Specifies the settings for indexing files found in an Object (such as a VM) so these files can be searched and recovered. In addition, it specifies inclusion and exclusion rules that determine the directories to index.' $ref: '#/components/schemas/IndexingPolicy' isActive: description: 'Indicates if the current state of the Protection Job is Active or Inactive. When you create a Protection Job on a Primary Cluster with a replication schedule, the Cohesity Cluster creates an Inactive copy of the Job on the Remote Cluster. In addition, when an Active and running Job is deactivated, the Job becomes Inactive.' type: - boolean - 'null' x-go-name: IsActive isDeleted: description: 'Equals ''true'' if the Protection Job was deleted but some Snapshots are still associated with this Job. If ''true'', no new Job Runs are started by this Protection Job.' type: - boolean - 'null' x-go-name: IsDeleted isDirectArchiveEnabled: description: Specifies if this is a direct archive backup job. type: - boolean - 'null' x-go-name: IsDirectArchiveEnabled isNativeFormat: description: 'Specifies if native format should be used for archiving, applicable for only direct archive jobs.' type: - boolean - 'null' x-go-name: IsNativeFormat isPaused: description: 'Indicates if the Protection Job is paused, which means that no new Job Runs are started but any existing Job Runs continue to execute.' type: - boolean - 'null' x-go-name: IsPaused lastRun: description: 'Specifies the last run of the Protection Job if any. This field is set only if it was requested.' $ref: '#/components/schemas/ProtectionRunInstance' leverageStorageSnapshots: description: 'Specifies 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.' type: - boolean - 'null' x-go-name: LeverageStorageSnapshots leverageStorageSnapshotsForHyperflex: description: Specifies whether to leverage Hyperflex as the storage snapshot array type: - boolean - 'null' x-go-name: LeverageStorageSnapshotsForHyperflex missingEntities: description: Specifies Information about missing entities. type: - array - 'null' items: $ref: '#/components/schemas/ProtectionSource' x-go-name: MissingEntities modificationTimeUsecs: description: Specifies the last time this Job was updated. type: - integer - 'null' format: int64 x-go-name: ModificationTimeUsecs modifiedByUser: description: Specifies the last Cohesity user who updated this Job. type: - string - 'null' x-go-name: ModifiedByUser name: description: Specifies the name of the Protection Job. type: - string - 'null' x-go-name: Name parentSourceId: description: 'Specifies the id of the registered Protection Source that is the parent of the Objects that may be protected by this Job. For example when a vCenter Server is registered on a Cohesity Cluster, the Cohesity Cluster assigns a unique id to this field that represents the vCenter Server.' type: - integer - 'null' format: int64 x-go-name: ParentSourceId performSourceSideDedup: description: Specifies whether source side dedupe should be performed or not. type: - boolean - 'null' x-go-name: PerformSourceSideDedup policyAppliedTimeMsecs: description: 'Specifies the epoch time (in milliseconds) when the associated Policy was last applied to this Job. This is used to determine if the Policy has changed since it was last applied to this Job.' type: - integer - 'null' format: int64 x-go-name: PolicyAppliedTimeMsecs policyId: description: 'Specifies the unique id of the Protection Policy associated with the Protection Job. The Policy provides retry settings, Protection Schedules, Priority, SLA, etc. The Job defines the Storage Domain (View Box), the Objects to Protect (if applicable), Start Time, Indexing settings, etc.' type: - string - 'null' x-go-name: PolicyId postBackupScript: description: 'Specifies the script associated with the backup job. This field must be specified for ''kPhysical'' jobs. This script will be executed post backup run.' allOf: - $ref: '#/components/schemas/BackupScript' preBackupScript: description: 'Specifies the script associated with the backup job. This field must be specified for ''kPhysical'' jobs. This script will be executed pre backup run. The ''remoteScript'' field will be used for remote adapter jobs and ''preBackupScript'' field will be used for ''kPhysical'' jobs.' allOf: - $ref: '#/components/schemas/BackupScript' priority: description: 'Specifies the priority of execution for a Protection Job. Cohesity supports concurrent backups but if the number of Jobs exceeds the ability to process Jobs, the specified priority determines the execution Job priority. This field also specifies the replication priority. ''kLow'' indicates lowest execution priority for a Protection job. ''kMedium'' indicates medium execution priority for a Protection job. ''kHigh'' indicates highest execution priority for a Protection job.' type: - string - 'null' enum: - kLow - kMedium - kHigh x-go-name: Priority qosType: description: 'Specifies the QoS policy type to use for this Protection Job. ''kBackupHDD'' indicates the Cohesity Cluster writes data directly to the HDD tier for this Protection Job. This is the recommended setting. ''kBackupSSD'' indicates the Cohesity Cluster writes data directly to the SSD tier for this Protection Job. Only specify this policy if you need fast ingest speed for a small number of Protection Jobs.' type: - string - 'null' enum: - kBackupHDD - kBackupSSD x-go-name: QosType quiesce: description: 'Indicates if the App-Consistent option is enabled for this Job. If the option is enabled, the Cohesity Cluster quiesces the file system and applications before taking Application-Consistent Snapshots. VMware Tools must be installed on the guest Operating System.' type: - boolean - 'null' x-go-name: Quiesce remoteScript: description: 'For a Remote Adapter ''kPuppeteer'' Job, this field specifies the settings about the remote script that will be executed by this Job. Only specify this field for Remote Adapter ''kPuppeteer'' Jobs.' allOf: - $ref: '#/components/schemas/RemoteJobScript' remoteViewName: description: Specifies the remote view name to use for view overwrite. type: - string - 'null' x-go-name: RemoteViewName sourceIds: description: 'Array of Protected Source Objects. Specifies the list of Object ids from the Protection Source to protect (or back up) by the Protection Job. An Object in this list may be descendant of another Object in this list. For example a Datacenter could be selected but its child Host excluded. However, a child VM under the Host could be explicitly selected to be protected. Both the Datacenter and the VM are listed.' type: - array - 'null' items: type: integer format: int64 x-go-name: SourceIds sourceSpecialParameters: description: 'Array of Special Source Parameters. Specifies additional settings that can apply to a subset of the Sources listed in the Protection Job. For example, you can specify a list of files and folders to protect instead of protecting the entire Physical Server. If this field''s setting conflicts with environmentParameters, then this setting will be used. Specific volume selections must be passed in here to take effect.' type: - array - 'null' items: $ref: '#/components/schemas/SourceSpecialParameter' x-go-name: SourceSpecialParameters startTime: description: 'Specifies the time of day to start the Protection Schedule. This is optional and only applicable if the Protection Policy defines a monthly or a daily Protection Schedule. Default value is 02:00 AM.' title: Protection Schedule Start Time. allOf: - $ref: '#/components/schemas/TimeOfDay' summaryStats: description: 'Specifies the summary stats of the Protection Job. This field is set only if it was requested.' $ref: '#/components/schemas/ProtectionJobSummaryStats' tenantId: description: Specifies the unique id of the tenant. type: - string - 'null' x-go-name: TenantId timezone: description: 'Specifies the timezone to use when calculating time for this Protection Job such as the Job start time. Specify the timezone in the following format: "Area/Location", for example: "America/New_York".' type: - string - 'null' x-go-name: Timezone uid: description: 'Specifies a global Protection Job id that is unique across Cohesity Clusters.' allOf: - $ref: '#/components/schemas/UniversalId' userSpecifiedTags: 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: UserSpecifiedTags viewBoxId: description: Specifies the Storage Domain (View Box) id where this Job writes data. type: - integer - 'null' format: int64 x-go-name: ViewBoxId viewName: description: 'For a Remote Adapter ''kPuppeteer'' Job or a ''kView'' Job, this field specifies a View name that should be protected. Specify this field when creating a Protection Job for the first time for a View. If this field is specified, ParentSourceId, SourceIds, and ExcludeSourceIds should not be specified.' type: - string - 'null' x-go-name: ViewName vmTagIds: description: 'Array of Arrays of VMs Tags Ids that Specify VMs to Protect. Optionally specify a list of VMs to protect by listing Protection Source ids of VM Tags in this two dimensional array. Using this two dimensional array of Tag ids, the Cluster generates a list of VMs to protect which are derived from intersections of the inner arrays and union of the outer array, as shown by the following example. To protect only ''Eng'' VMs in the East and all the VMs in the West, specify the following tag id array: [ [1101, 2221], [3031] ], where 1101 is the ''Eng'' VM Tag id, 2221 is the ''East'' VM Tag id and 3031 is the ''West'' VM Tag id. The inner array [1101, 2221] produces a list of VMs that are both tagged with ''Eng'' and ''East'' (an intersection). The outer array combines the list from the inner array with list of VMs tagged with ''West'' (a union). The list of resulting VMs are protected by this Job.' type: - array - 'null' items: type: array items: type: integer format: int64 x-go-name: VmTagIds x-go-package: cohesity/iris/server/data/public BackupSourceStats: description: 'Specifies statistics about a Backup task in a Protection Job Run. Specifies statistics for one backup task. One backup task is used to backup on Protection Source. This structure is also used to aggregate stats of a Backup tasks in a Protection Job Run.' type: object title: Backup Run Statistics. properties: admittedTimeUsecs: description: 'Specifies the time the task was unqueued from the queue to start running. This field can be used to determine the following times: initial-wait-time = admittedTimeUsecs - startTimeUsecs run-time = endTimeUsecs - admittedTimeUsecs If the task ends up waiting in other queues, then actual run-time will be smaller than the run-time computed this way. This field is only populated for Backup tasks currently.' type: - integer - 'null' format: int64 x-go-name: AdmittedTimeUsecs endTimeUsecs: description: 'Specifies the end time of the Protection Run. The end time is specified as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: EndTimeUsecs startTimeUsecs: description: 'Specifies the start time of the Protection Run. The start time is specified as a Unix epoch Timestamp (in microseconds). This time is when the task is queued to an internal queue where tasks are waiting to run.' type: - integer - 'null' format: int64 x-go-name: StartTimeUsecs timeTakenUsecs: description: 'Specifies the actual execution time for the protection run to complete the backup task and the copy tasks. This time will not include the time waited in various internal queues. This field is only populated for Backup tasks currently.' type: - integer - 'null' format: int64 x-go-name: TimeTakenUsecs totalBytesReadFromSource: description: Specifies the total amount of data read from the source (so far). type: - integer - 'null' format: int64 x-go-name: TotalBytesReadFromSource totalBytesToReadFromSource: description: 'Specifies the total amount of data expected to be read from the source.' type: - integer - 'null' format: int64 x-go-name: TotalBytesToReadFromSource totalLogicalBackupSizeBytes: description: 'Specifies the size of the source object (such as a VM) protected by this task on the primary storage after the snapshot is taken. The logical size of the data on the source if the data is fully hydrated or expanded and not reduced by change-block tracking, compression and deduplication.' type: - integer - 'null' format: int64 x-go-name: TotalLogicalBackupSizeBytes totalPhysicalBackupSizeBytes: description: 'Specifies the total amount of physical space used on the Cohesity Cluster to store the protected object after being reduced by change-block tracking, compression and deduplication. For example, if the logical backup size is 1GB, but only 1MB was used on the Cohesity Cluster to store it, this field be equal to 1MB.' type: - integer - 'null' format: int64 x-go-name: TotalPhysicalBackupSizeBytes totalSourceSizeBytes: description: 'Specifies the size of the source object (such as a VM) protected by this task on the primary storage before the snapshot is taken. The logical size of the data on the source if the data is fully hydrated or expanded and not reduced by change-block tracking, compression and deduplication.' type: - integer - 'null' format: int64 x-go-name: TotalSourceSizeBytes x-go-package: cohesity/iris/server/data/public CassandraConnectParams: description: 'Specifies an Object containing information about a registered cassandra source.' type: object title: Cassandra Connect Params. properties: cassandraPortsInfo: description: Specifies the ports related info. $ref: '#/components/schemas/CassandraPortsInfo' cassandraSecurityInfo: description: Specifies the security related info. $ref: '#/components/schemas/CassandraSecurityInfo' cassandraVersion: description: Cassandra version type: - string - 'null' x-go-name: CassandraVersion configDirectory: description: Specifies the Directory path containing Config YAML for discovery. type: - string - 'null' x-go-name: ConfigDirectory dataCenters: description: 'Specifies the List of all physical data center or virtual data center. In most cases, the data centers will be listed after discovery operation however, if they are not listed, you must manually type the data center names. Leaving the field blank will disallow data center-specific backup or restore. Entering a subset of all data centers may cause problems in data movement.' type: - array - 'null' items: type: string x-go-name: DataCenters dseConfigDirectory: description: Specifies the Directory from where DSE specific configuration can be read. type: - string - 'null' x-go-name: DseConfigDirectory isDseAuthenticator: description: Specifies whether this cluster has DSE Authenticator. type: - boolean - 'null' x-go-name: IsDseAuthenticator isDseTieredStorage: description: Specifies whether this cluster has DSE tiered storage. type: - boolean - 'null' x-go-name: IsDseTieredStorage isJmxAuthEnable: description: Specifies if JMX Authentication enabled in this cluster. type: - boolean - 'null' x-go-name: IsJmxAuthEnable kerberosPrincipal: description: Specifies the Kerberos Principal for Kerberos connection type: - string - 'null' x-go-name: KerberosPrincipal primaryHost: description: Specifies the Primary Host for the Cassandra cluster. type: - string - 'null' x-go-name: PrimaryHost seeds: description: Specifies the Seed nodes of this Cassandra cluster. type: - array - 'null' items: type: string x-go-name: Seeds solrNodes: description: Specifies the Solr node IP Addresses type: - array - 'null' items: type: string x-go-name: SolrNodes solrPort: description: Specifies the Solr node Port. type: - integer - 'null' format: int32 x-go-name: SolrPort x-go-package: cohesity/iris/server/data/public GcpParams: description: Specifies various resources when converting and deploying a VM to GCP. type: object title: GCP Parameters. properties: instanceId: description: Specifies id of the GCP instance type in which to deploy the VM. type: - integer - 'null' format: int64 x-go-name: ProjectId region: description: Specifies id of the GCP region in which to deploy the VM. type: - integer - 'null' format: int64 x-go-name: RegionId subnetId: description: Specifies id of the subnet within above VPC. type: - integer - 'null' format: int64 x-go-name: Subnet virtualPrivateCloudId: description: Specifies id of the Virtual Private Cloud to chose for the instance type. type: - integer - 'null' format: int64 x-go-name: Zone x-go-package: cohesity/iris/server/data/public ApplicationSpecialParameters: description: 'Specifies additional special settings applicable for a Protection Source of ''kSQL''/''kOracle'' type in a Protection Job.' type: object title: Application Special Job Parameters. properties: applicationEntityIds: description: 'Array of Ids of Application Entities like SQL/Oracle instances, and databases that should be protected in a Protection Source. Specifies the subset of application entities like SQL/Oracle instances, and databases to protect in a Protection Source of type ''kSQL''/''kOracle''. If not specified, all application entities on the Protection Source.' type: - array - 'null' items: type: integer format: int64 x-go-name: ApplicationEntityIds x-go-package: cohesity/iris/server/data/public ProtectionJobSummaryStats: description: Specifies statistics about a Protection Job. type: object title: Protection Job Summary Statistics. properties: averageRunTimeUsecs: description: 'Specifies the average run time of all successful Protection Runs. It is specified as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: AverageRunTimeUsecs fastestRunTimeUsecs: description: 'Specifies the time taken for a fastest successful Protection Run so far. It is specified as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: FastestRunTimeUsecs numCanceledRuns: description: Specifies the number of runs that were cancelled. type: - integer - 'null' format: int64 x-go-name: NumCanceledRuns numFailedRuns: description: Specifies the number of runs that failed to finish. type: - integer - 'null' format: int64 x-go-name: NumFailedRuns numSlaViolations: description: Specifies the number of runs having SLA violations. type: - integer - 'null' format: int64 x-go-name: NumSlaViolations numSuccessfulRuns: description: Specifies the number of runs that finished successfully. type: - integer - 'null' format: int64 x-go-name: NumSuccessfulRuns slowestRunTimeUsecs: description: 'Specifies the time taken for a slowest successful Protection Run so far. It is specified as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: SlowestRunTimeUsecs totalBytesReadFromSource: description: Specifies the total amount of data read from the source (so far). type: - integer - 'null' format: int64 x-go-name: TotalBytesReadFromSource totalLogicalBackupSizeBytes: description: 'Specifies the size of the source object (such as a VM) protected by this task on the primary storage after the snapshot is taken. The logical size of the data on the source if the data is fully hydrated or expanded and not reduced by change-block tracking, compression and deduplication.' type: - integer - 'null' format: int64 x-go-name: TotalLogicalBackupSizeBytes totalPhysicalBackupSizeBytes: description: 'Specifies the total amount of physical space used on the Cohesity Cluster to store the protected object after being reduced by change-block tracking, compression and deduplication. For example, if the logical backup size is 1GB, but only 1MB was used on the Cohesity Cluster to store it, this field be equal to 1MB.' type: - integer - 'null' format: int64 x-go-name: TotalPhysicalBackupSizeBytes x-go-package: cohesity/iris/server/data/public WindowsHostSnapshotParameters: description: Specifies settings that are meaningful only on Windows hosts. type: object title: Windows Host Snapshot Parameters. properties: copyOnlyBackup: description: 'Specifies whether to backup regardless of the state of each file''s backup history. Backup history will not be updated. Refer Microsoft documentation on VSS_BT_COPY.' type: - boolean - 'null' x-go-name: CopyOnlyBackup disableMetadata: description: 'Specifies whether to disable fetching and storing of some metadata on Cohesity Cluster to save storage space. Otherwise, there will be some metadata fetched and stored on Cohesity Cluster.' type: - boolean - 'null' x-go-name: DisableMetadata disableNotification: description: 'Specifies whether to disable some notification steps when taking snapshots.' type: - boolean - 'null' x-go-name: DisableNotification excludedVssWriters: description: 'Specifies a list of Windows VSS writers that are excluded from backups. For example, "ASR Writer", "System Writer". Refer Microsoft documentaion for a complete list.' type: - array - 'null' items: type: string x-go-name: ExcludedVssWriters x-go-package: cohesity/iris/server/data/public ClusterNetworkingResourceInformation: description: Specifies a resource with IP address. type: object title: Cluster Networking Resource Information. properties: endpoints: description: The endpoints by which the resource is accessible. type: - array - 'null' items: $ref: '#/components/schemas/ClusterNetworkingEndpoint' x-go-name: EndpointVec type: description: The type of the resource. type: - string - 'null' x-go-name: Type x-go-package: cohesity/iris/server/data/public ProtectionShellInfo: type: object title: ProtectionShellInfo specifies the shell information about a protection run. properties: endTimeUsecs: description: 'Specifies the end time of the Protection Run. The end time is specified as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: EndTimeUsecs error: description: 'Specifies if an error occurred (if any) while running this task. This field is populated when the status is equal to ''kFailure''.' type: - string - 'null' x-go-name: Error jobRunId: description: 'Specifies the id of the Job Run that ran the backup task and the copy tasks.' type: - integer - 'null' format: int64 x-go-name: JobRunId runType: description: 'Specifies the type of backup such as ''kRegular'', ''kFull'', ''kLog'' or ''kSystem''. ''kRegular'' indicates a incremental (CBT) backup. Incremental backups utilizing CBT (if supported) are captured of the target protection objects. The first run of a kRegular schedule captures all the blocks. ''kFull'' indicates a full (no CBT) backup. A complete backup (all blocks) of the target protection objects are always captured and Change Block Tracking (CBT) is not utilized. ''kLog'' indicates a Database Log backup. Capture the database transaction logs to allow rolling back to a specific point in time. ''kSystem'' indicates a system backup. System backups are used to do bare metal recovery of the system to a specific point in time.' type: - string - 'null' enum: - kRegular - kFull - kLog - kSystem x-go-name: RunType startTimeUsecs: description: 'Specifies the start time of the Protection Run. The start time is specified as a Unix epoch Timestamp (in microseconds). This time is when the task is queued to an internal queue where tasks are waiting to run.' type: - integer - 'null' format: int64 x-go-name: StartTimeUsecs status: description: 'Specifies the status of Backup task such as ''kRunning'', ''kSuccess'', ''kFailure'' etc. ''kAccepted'' indicates the task is queued to run but not yet running. ''kRunning'' indicates the task is running. ''kCanceling'' indicates a request to cancel the task has occurred but the task is not yet canceled. ''kCanceled'' indicates the task has been canceled. ''kSuccess'' indicates the task was successful. ''kFailure'' indicates the task failed. ''kWarning'' indicates the task has finished with warning. ''kOnHold'' indicates the task is kept onHold. ''kMissed'' indicates the task is missed.' type: - string - 'null' enum: - kAccepted - kRunning - kCanceling - kCanceled - kSuccess - kFailure - kWarning - kOnHold - kMissed x-go-name: Status x-go-package: cohesity/iris/server/data/public VCloudDirectorInfo: type: object title: VCloudDirectorInfo Information. properties: endpoint: description: vCenter endpoint. type: - string - 'null' x-go-name: Endpoint name: description: vCenter name. type: - string - 'null' x-go-name: Name x-go-package: cohesity/iris/server/data/public TimeOfDay: description: Specifies a time in day with hours and minutes. type: object title: Time of Day. properties: hour: description: Specifies an (0-23) hour in a day. type: - integer - 'null' format: int32 x-go-name: Hour minute: description: Specifies a (0-59) minute in an hour. type: - integer - 'null' format: int32 x-go-name: Minute x-go-package: cohesity/iris/server/data/public CassandraCluster: description: Specifies an Object containing information about a Cassandra cluster. type: object title: Cassandra Cluster Info. properties: primaryHost: description: Primary host from this Cassandra cluster. type: - string - 'null' x-go-name: PrimaryHost seeds: description: Seeds of this Cassandra Cluster. type: - array - 'null' items: type: string x-go-name: Seeds x-go-package: cohesity/iris/server/data/public SqlProtectionSource: description: Specifies an Object representing one SQL Server instance or database. type: object title: SQL Protection Source. properties: IsAvailableForVssBackup: description: 'Specifies whether the database is marked as available for backup according to the SQL Server VSS writer. This may be false if either the state of the databases is not online, or if the VSS writer is not online. This field is set only for type ''kDatabase''.' type: - boolean - 'null' createdTimestamp: description: 'Specifies the time when the database was created. It is displayed in the timezone of the SQL server on which this database is running.' type: - string - 'null' x-go-name: CreatedTimestamp databaseName: description: 'Specifies the database name of the SQL Protection Source, if the type is database.' type: - string - 'null' x-go-name: DatabaseName dbAagEntityId: description: 'Specifies the AAG entity id if the database is part of an AAG. This field is set only for type ''kDatabase''.' type: - integer - 'null' format: int64 x-go-name: DbAagEntityId dbAagName: description: 'Specifies the name of the AAG if the database is part of an AAG. This field is set only for type ''kDatabase''.' type: - string - 'null' x-go-name: DbAagName dbCompatibilityLevel: description: 'Specifies the versions of SQL server that the database is compatible with.' type: - integer - 'null' format: int64 x-go-name: DbCompatibilityLevel dbFileGroups: description: 'Specifies the information about the set of file groups for this db on the host. This is only set if the type is kDatabase.' type: - array - 'null' items: type: string x-go-name: DbFileGroups dbFiles: description: 'Specifies the last known information about the set of database files on the host. This field is set only for type ''kDatabase''.' type: - array - 'null' items: $ref: '#/components/schemas/DbFileInfo' x-go-name: DbFiles dbOwnerUsername: description: Specifies the name of the database owner. type: - string - 'null' x-go-name: DbOwnerUsername id: description: Specifies an id that identifies an SQL Object. $ref: '#/components/schemas/SqlSourceId' name: description: Specifies the instance name of the SQL Protection Source type: - string - 'null' x-go-name: Name ownerId: description: Specifies the id of the container VM for the SQL Protection Source. type: - integer - 'null' format: int64 x-go-name: OwnerId recoveryModel: description: 'Specifies the Recovery Model for the database in SQL environment. Only meaningful for the ''kDatabase'' SQL Protection Source. Specifies the Recovery Model set for the Microsoft SQL Server. ''kSimpleRecoveryModel'' indicates the Simple SQL Recovery Model which does not utilize log backups. ''kFullRecoveryModel'' indicates the Full SQL Recovery Model which requires log backups and allows recovery to a single point in time. ''kBulkLoggedRecoveryModel'' indicates the Bulk Logged SQL Recovery Model which requires log backups and allows high-performance bulk copy operations.' type: - string - 'null' enum: - kSimpleRecoveryModel - kFullRecoveryModel - kBulkLoggedRecoveryModel x-go-name: RecoveryModel sqlServerDbState: description: 'The state of the database as returned by SQL Server. Indicates the state of the database. The values correspond to the ''state'' field in the system table sys.databases. See https://goo.gl/P66XqM. ''kOnline'' indicates that database is in online state. ''kRestoring'' indicates that database is in restore state. ''kRecovering'' indicates that database is in recovery state. ''kRecoveryPending'' indicates that database recovery is in pending state. ''kSuspect'' indicates that primary filegroup is suspect and may be damaged. ''kEmergency'' indicates that manually forced emergency state. ''kOffline'' indicates that database is in offline state. ''kCopying'' indicates that database is in copying state. ''kOfflineSecondary'' indicates that secondary database is in offline state.' type: - string - 'null' enum: - kOnline - kRestoring - kRecovering - kRecoveryPending - kSuspect - kEmergency - kOffline - kCopying - kOfflineSecondary x-go-name: SqlServerDbState sqlServerInstanceVersion: description: The version of the SQL instance. $ref: '#/components/schemas/SQLServerInstanceVersion' type: description: 'Specifies the type of the managed Object in a SQL Protection Source. Examples of SQL Objects include ''kInstance'' and ''kDatabase''. ''kInstance'' indicates that SQL server instance is being protected. ''kDatabase'' indicates that SQL server database is being protected. ''kAAG'' indicates that SQL AAG (AlwaysOn Availability Group) is being protected. ''kAAGRootContainer'' indicates that SQL AAG''s root container is being protected. ''kRootContainer'' indicates root container for SQL sources.' type: - string - 'null' enum: - kInstance - kDatabase - kAAG - kAAGRootContainer - kRootContainer x-go-name: Type x-go-package: cohesity/iris/server/data/public OraclePluggableDatabaseInfo: description: 'Specifies the informatiomn about the pluggable database. A Pluggabele Database(PDB) is a portable collection of schemas, schema objects, and nonschema objects that appears to an Oracle Net client as a non-CDB.' type: object properties: databaseId: description: Specifies the ID of the Pluggable Database. type: - string - 'null' x-go-name: DatabaseId name: description: Speicifes the name of the Pluggable Database. type: - string - 'null' x-go-name: Name openMode: description: 'Specifies the OPEN_MODE information. Specifies the OPEN_MODE type for the Oracle database. ''kMounted'' indicates that the database is open in Mounted mode. ''kReadWrite'' indicates that the database is open in R/W mode. ''kReadOnly'' indicates that the database is open in ReadOnly mode. ''kMigrate'' inidcates that the database is open in Migrate mode.' type: - string - 'null' enum: - kMounted - kReadWrite - kReadOnly - kMigrate x-go-name: OpenMode sizeBytes: description: Specifies the Size in Bytes of the Pluggable Database. type: - integer - 'null' format: int64 x-go-name: SizeBytes x-go-package: cohesity/iris/server/data/public SanVolume: description: Specifies a SAN Volume in a SAN Storage Array. type: object title: SAN Volume. properties: createdTime: description: Specifies the created time (e.g., "2015-07-21T17:59:41Z") of the volume. type: - string - 'null' x-go-name: CreatedTime parentVolume: description: 'Specifies the name of the source volume, if this volume was copied or cloned from it.' type: - string - 'null' x-go-name: ParentVolume serialNumber: description: Specifies the serial number of the volume. type: - string - 'null' x-go-name: SerialNumber sizeBytes: description: Specifies the provisioned size in bytes of the volume. type: - integer - 'null' format: int64 x-go-name: SizeBytes usedBytes: description: Specifies the total space actually used by the volume. type: - integer - 'null' format: int64 x-go-name: UsedBytes x-go-package: cohesity/iris/server/data/public DataMigrationJobParameters: description: Specifies parameters applicable for data migration jobs in NAS environment. type: object title: Data Migration Job Parameters. properties: coldFileWindow: description: 'Identifies the cold files in the NAS source. Files that haven''t been accessed/modified in the last cold_file_window 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 filePathFilter: description: 'The filtering policy to decide which objects within a source should be migrated. If this is not specified, then all the objects within the source will be migrated based on the migration policy.' $ref: '#/components/schemas/FilePathFilter' fileSelectionPolicy: description: 'Specifies policy to select a file to migrate based on its creation, last access or modification time. eg. A file can be selected to migrate if it has not been accessed/modified in the ColdFileWindow. enum: kOlderThan, kLastAccessed, kLastModified. Specifies policy for file selection in data migration jobs based on time. ''kOlderThan'': Migrate the files that are older than cold file window. ''kLastAccessed'': Migrate the files that are not accessed in cold file window. ''kLastModified'': Migrate the files that have not been modified in cold file window.' type: - string - 'null' enum: - kOlderThan - kLastAccessed - kLastModified x-go-name: FileSelectionPolicy fileSizeBytes: description: 'Gives the size criteria to be used for selecting the files to be migrated in bytes. The cold files that are equal and greater than this size are migrated.' type: - integer - 'null' format: int64 x-go-name: FileSizeBytes fileSizePolicy: description: 'Specifies policy to select a file to migrate based on its size. eg. A file can be selected to migrate if its size is greater than or smaller than the FileSizeBytes. enum: kGreaterThan, kSmallerThan. Specifies policy for file selection in data migration jobs based on file size. ''kGreaterThan'': Migrate the files whose size are greater than specified file size. ''kSmallerThan'': Migrate the files whose size are smaller than specified file size.' type: - string - 'null' enum: - kGreaterThan - kSmallerThan x-go-name: FileSizePolicy migrateWithoutStub: description: Specifies if data is to be migrated without stub. type: - boolean - 'null' x-go-name: MigrateWithoutStub nfsMountPath: description: 'Mount path where the 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: cohesity/iris/server/data/public SnapshotArchivalCopyPolicy: description: 'Specifies settings for copying Snapshots External Targets (such as AWS or Tape). This also specifies the retention policy that should be applied to Snapshots after they have been copied to the specified target.' type: object title: Snapshot Copy Archival Policy. properties: Id: description: 'Specified the Id for a snapshot copy policy. This is generated when the policy is created.' type: - string - 'null' copyPartial: description: 'Specifies if Snapshots are copied from the first completely successful Job Run or the first partially successful Job Run occurring at the start of the replication schedule. If true, Snapshots are copied from the first Job Run occurring at the start of the replication schedule, even if first Job Run was not completely successful i.e. Snapshots were not captured for all Objects in the Job. If false, Snapshots are copied from the first Job Run occurring at the start of the replication schedule that was completely successful i.e. Snapshots for all the Objects in the Job were successfully captured.' type: - boolean - 'null' x-go-name: CopyPartial datalockConfig: description: 'Specifies WORM retention type for the copy target snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept for the last N days as specified in the duration of the datalock. During that time, the snapshots cannot be deleted.' $ref: '#/components/schemas/DataLockConfig' daysToKeep: description: Specifies the number of days to retain copied Snapshots on the target. type: - integer - 'null' format: int64 x-go-name: DaysToKeep multiplier: description: 'Specifies a factor to multiply the periodicity by, to determine the copy schedule. For example if set to 2 and the periodicity is hourly, then Snapshots from the first eligible Job Run for every 2 hour period is copied.' type: - integer - 'null' format: int32 x-go-name: Multiplier periodicity: description: 'Specifies the frequency that Snapshots should be copied to the specified target. Used in combination with multiplier. ''kEvery'' means that the Snapshot copy occurs after the number of Job Runs equals the number specified in the multiplier. ''kHour'' means that the Snapshot copy occurs hourly at the frequency set in the multiplier, for example if multiplier is 2, the copy occurs every 2 hours. ''kDay'' means that the Snapshot copy occurs daily at the frequency set in the multiplier. ''kWeek'' means that the Snapshot copy occurs weekly at the frequency set in the multiplier. ''kMonth'' means that the Snapshot copy occurs monthly at the frequency set in the multiplier. ''kYear'' means that the Snapshot copy occurs yearly at the frequency set in the multiplier.' type: - string - 'null' enum: - kEvery - kHour - kDay - kWeek - kMonth - kYear x-go-name: Periodicity target: description: Specifies the archival target to copy the Snapshots to. allOf: - $ref: '#/components/schemas/ArchivalExternalTarget' x-go-package: cohesity/iris/server/data/public NetappClusterInfo: description: Specifies information about a NetApp Cluster Protection Source. type: object title: NetApp Cluster Information. properties: contactInfo: description: 'Specifies information about the contact for the NetApp cluster such as a name, phone number, and email address.' type: - string - 'null' x-go-name: ContactInfo location: description: 'Specifies where this NetApp cluster is located. This location identification string is configured by the NetApp system administrator. This field does not contain the NetApp cluster hostname or IP address.' type: - string - 'null' x-go-name: Location serialNumber: description: 'Specifies the serial number of the NetApp cluster in the format: x-xx-xxxxxx.' type: - string - 'null' x-go-name: SerialNumber x-go-package: cohesity/iris/server/data/public ElastifileProtectionSource: description: Specifies a Protection Source in Elastifile environment. type: object title: Elastifile Protection Source. properties: cluster: description: 'Specifies information of Elastifile Cluster. This is set only when the entity type is ''kCluster''.' $ref: '#/components/schemas/ElastifileCluster' container: description: 'Specifies a container in an Elastifile Cluster. This is set only when the entity type is ''kContainer''.' $ref: '#/components/schemas/ElastifileContainer' name: description: Specifies a unique name of the Protection Source. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of the entity in an Elastifile file system like ''kCluster'', ''kContainer''. ''kCluster'' indicates an Elastifile Cluster. ''kContainer'' indicates a container on Elastifile cluster.' type: - string - 'null' enum: - kCluster - kContainer x-go-name: Type x-go-package: cohesity/iris/server/data/public SourceBackupStatus: description: Specifies the source object to protect and the current backup status. type: object title: Source Object Backup Status. properties: appsBackupStatus: description: Specifies the backup status at app/DB level. type: - array - 'null' items: $ref: '#/components/schemas/AppEntityBackupStatusInfo' x-go-name: AppsBackupStatus currentSnapshotInfo: description: 'Specifies details about the snapshot captured to backup the source object (such as a VM).' $ref: '#/components/schemas/SnapshotInfo' error: description: 'Specifies if an error occurred (if any) while running this task. This field is populated when the status is equal to ''kFailure''.' type: - string - 'null' x-go-name: Error isFullBackup: description: 'Specifies whether this is a ''kFull'' or ''kRegular'' backup of the Run. This may be true even if the scheduled backup type is ''kRegular''. This will happen when this run corresponds to the first backup run of the Job or if no previous snapshot information is found.' type: - boolean - 'null' x-go-name: IsFullBackup numRestarts: description: 'Specifies the number of times the task was restarted because of the changes on the backup source host.' type: - integer - 'null' format: int32 x-go-name: NumRestarts parentSourceId: description: 'Specifies the id of the registered Protection Source that is the parent of the Objects that are protected by this Job Run.' type: - integer - 'null' format: int64 x-go-name: ParentSourceId progressMonitorTaskPath: description: 'Specifies the yoda progress monitor task path which is used to get pulse information about the source that is being backed up.' type: - string - 'null' x-go-name: ProgressMonitorTaskPath quiesced: description: 'Specifies if app-consistent snapshot was captured. This field is set to true, if an app-consistent snapshot was taken by quiescing applications and the file system before taking a backup.' type: - boolean - 'null' x-go-name: Quiesced slaViolated: description: 'Specifies if the SLA was violated for the Job Run. This field is set to true, if time to complete the Job Run is longer than the SLA specified. This field is populated when the status is set to ''kSuccess'' or ''kFailure''.' type: - boolean - 'null' x-go-name: SlaViolated source: description: Specifies the source object to protect. $ref: '#/components/schemas/ProtectionSource' stats: description: Specifies the stats of the Backup Run task for the Protection Source. $ref: '#/components/schemas/BackupSourceStats' status: description: 'Specifies the status of the source object being protected. ''kAccepted'' indicates the task is queued to run but not yet running. ''kRunning'' indicates the task is running. ''kCanceling'' indicates a request to cancel the task has occurred but the task is not yet canceled. ''kCanceled'' indicates the task has been canceled. ''kSuccess'' indicates the task was successful. ''kFailure'' indicates the task failed. ''kWarning'' indicates the task has finished with warning. ''kOnHold'' indicates the task is kept onHold. ''kMissed'' indicates the task is missed.' type: - string - 'null' enum: - kAccepted - kRunning - kCanceling - kCanceled - kSuccess - kFailure - kWarning - kOnHold - kMissed x-go-name: Status warnings: description: 'Array of Warnings. Specifies the warnings that occurred (if any) while running this task.' type: - array - 'null' items: type: string x-go-name: Warnings x-go-package: cohesity/iris/server/data/public GroupInfo: description: Specifies struct with basic group details. type: object title: Group Information. properties: domain: description: Specifies domain name of the user. type: - string - 'null' x-go-name: Domain groupName: description: Specifies group name of the group. type: - string - 'null' x-go-name: GroupName sid: description: Specifies unique Security ID (SID) of the user. type: - string - 'null' x-go-name: Sid tenantIds: description: Specifies the tenants to which the group belongs to. type: - array - 'null' items: type: string x-go-name: TenantIds x-go-package: cohesity/iris/server/data/public RegisteredSourceInfo: description: Specifies information about a registered Source. type: object title: Registered Source Info. properties: accessInfo: description: 'Specifies the parameters required to establish a connection with a particular environment.' $ref: '#/components/schemas/ConnectorParameters' authenticationErrorMessage: description: 'Specifies an authentication error message. This indicates the given credentials are rejected and the registration of the source is not successful.' type: - string - 'null' x-go-name: AuthenticationErrorMessage authenticationStatus: description: 'Specifies the status of the authenticating to the Protection Source when registering it with Cohesity Cluster. If the status is ''kFinished'' and there is no error, registration is successful. Specifies the status of the authentication during the registration of a Protection Source. ''kPending'' indicates the authentication is in progress. ''kScheduled'' indicates the authentication is scheduled. ''kFinished'' indicates the authentication is completed. ''kRefreshInProgress'' indicates the refresh is in progress.' type: - string - 'null' enum: - kPending - kScheduled - kFinished - kRefreshInProgress x-go-name: AuthenticationStatus blacklistedIpAddresses: description: 'Specifies the list of IP Addresses on the registered source to be blacklisted for doing any type of IO operations.' type: - array - 'null' items: type: string x-go-name: BlacklistedIpAddresses cassandraParams: description: 'Contains all the additional params specified by the user while registering the Cassandra source.' $ref: '#/components/schemas/CassandraConnectParams' couchbaseParams: description: 'Contains all the additional params specified by the user while registering the Couchbase source.' $ref: '#/components/schemas/CouchbaseConnectParams' environments: description: 'Specifies a list of applications environment that are registered with this Protection Source such as ''kSQL''. Supported environment types such as ''kView'', ''kSQL'', ''kVMware'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter. ''kVMware'' indicates the VMware Protection Source environment. ''kHyperV'' indicates the HyperV Protection Source environment. ''kSQL'' indicates the SQL Protection Source environment. ''kView'' indicates the View Protection Source environment. ''kPuppeteer'' indicates the Cohesity''s Remote Adapter. ''kPhysical'' indicates the physical Protection Source environment. ''kPure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''kAzure'' indicates the Microsoft''s Azure Protection Source environment. ''kNetapp'' indicates the Netapp Protection Source environment. ''kAgent'' indicates the Agent Protection Source environment. ''kGenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''kAcropolis'' indicates the Acropolis Protection Source environment. ''kPhsicalFiles'' indicates the Physical Files Protection Source environment. ''kIsilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''kGPFS'' indicates IBM''s GPFS Protection Source environment. ''kKVM'' indicates the KVM Protection Source environment. ''kAWS'' indicates the AWS Protection Source environment. ''kExchange'' indicates the Exchange Protection Source environment. ''kHyperVVSS'' indicates the HyperV VSS Protection Source environment. ''kOracle'' indicates the Oracle Protection Source environment. ''kGCP'' indicates the Google Cloud Platform Protection Source environment. ''kFlashBlade'' indicates the Flash Blade Protection Source environment. ''kAWSNative'' indicates the AWS Native Protection Source environment. ''kO365'' indicates the Office 365 Protection Source environment. ''kO365Outlook'' indicates Office 365 outlook Protection Source environment. ''kHyperFlex'' indicates the Hyper Flex Protection Source environment. ''kGCPNative'' indicates the GCP Native Protection Source environment. ''kAzureNative'' indicates the Azure Native Protection Source environment. ''kKubernetes'' indicates a Kubernetes Protection Source environment. ''kElastifile'' indicates Elastifile Protection Source environment. ''kAD'' indicates Active Directory Protection Source environment. ''kRDSSnapshotManager'' indicates AWS RDS Protection Source environment. ''kCassandra'' indicates Cassandra Protection Source environment. ''kMongoDB'' indicates MongoDB Protection Source environment. ''kCouchbase'' indicates Couchbase Protection Source environment. ''kHdfs'' indicates Hdfs Protection Source environment. ''kHive'' indicates Hive Protection Source environment. ''kHBase'' indicates HBase Protection Source environment.' type: - array - 'null' items: type: string enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kNimble - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kAzureNative - kKubernetes - kElastifile - kAD - kRDSSnapshotManager - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase x-go-name: Environments hbaseParams: description: 'Contains all the additional params specified by the user while registering the HBase source.' $ref: '#/components/schemas/HBaseConnectParams' hdfsParams: description: 'Contains all the additional params specified by the user while registering the Hdfs source.' $ref: '#/components/schemas/HdfsConnectParams' hiveParams: description: 'Contains all the additional params specified by the user while registering the Hive source.' $ref: '#/components/schemas/HiveConnectParams' isDbAuthenticated: description: 'Specifies if application entity dbAuthenticated or not. ex: oracle database.' type: - boolean - 'null' x-go-name: IsDbAuthenticated minimumFreeSpaceGB: description: 'Specifies the minimum free space in GiB of the space expected to be available on the datastore where the virtual disks of the VM being backed up. If the amount of free space(in GiB) is lower than the value given by this field, backup will be aborted. Note that this field is applicable only to ''kVMware'' type of environments.' type: - integer - 'null' format: int64 x-go-name: MinimumFreeSpaceGB mongodbParams: description: 'Contains all the additional params specified by the user while registering the MongoDB source.' $ref: '#/components/schemas/MongoDBConnectParams' nasMountCredentials: description: 'Specifies the credentials required to mount directories on the NetApp server if given.' title: NAS Server Credentials. allOf: - $ref: '#/components/schemas/NasMountCredentialParams' office365CredentialsList: description: 'Office365 Source Credentials. Specifies credentials needed to authenticate & authorize user for Office365.' type: - array - 'null' items: $ref: '#/components/schemas/Office365Credentials' x-go-name: Office365CredentialsList office365Region: description: Specifies the region for Office365. type: - string - 'null' x-go-name: Office365Region password: description: Specifies password of the username to access the target source. type: - string - 'null' x-go-name: Password refreshErrorMessage: description: 'Specifies a message if there was any error encountered during the last rebuild of the Protection Source tree. If there was no error during the last rebuild, this field is reset.' type: - string - 'null' x-go-name: RefreshErrorMessage refreshTimeUsecs: description: 'Specifies the Unix epoch time (in microseconds) when the Protection Source tree was most recently fetched and built.' type: - integer - 'null' format: int64 x-go-name: RefreshTimeUsecs registeredAppsInfo: description: 'Specifies information of the applications registered on this protection source.' type: - array - 'null' items: $ref: '#/components/schemas/RegisteredAppInfo' x-go-name: RegisteredAppsInfo registrationTimeUsecs: description: 'Specifies the Unix epoch time (in microseconds) when the Protection Source was registered.' type: - integer - 'null' format: int64 x-go-name: RegistrationTimeUsecs subnets: description: 'Specifies the list of subnets added during creation or updation of vmare source. Currently, this field will only be populated in case of VMware registration.' type: - array - 'null' items: $ref: '#/components/schemas/Subnet' x-go-name: Subnets throttlingPolicy: description: 'Specifies the throttling policy that should be applied to all datastores under this registered Protection Source.' $ref: '#/components/schemas/ThrottlingPolicyParameters' throttlingPolicyOverrides: description: 'Array of Throttling Policy Overrides for Datastores. Specifies a list of Throttling Policy for datastores that override the common throttling policy specified for the registered Protection Source. For datastores not in this list, common policy will still apply.' type: - array - 'null' items: $ref: '#/components/schemas/ThrottlingPolicyOverride' x-go-name: ThrottlingPolicyOverrides useOAuthForExchangeOnline: description: 'Specifies whether OAuth should be used for authentication in case of Exchange Online.' type: - boolean - 'null' x-go-name: UseOAuthForExchangeOnline useVmBiosUuid: description: 'Specifies if registered vCenter is using BIOS UUID to track virtual machines.' type: - boolean - 'null' x-go-name: UseVmBiosUuid username: description: Specifies username to access the target source. type: - string - 'null' x-go-name: Username vlanParams: description: 'Specifies the VLAN parameters to be used for performing the backup/restore of this entity.' $ref: '#/components/schemas/VlanParameters' warningMessages: description: 'Specifies a list of warnings encountered during registration. Though the registration may succeed, warning messages imply the host environment requires some cleanup or fixing.' type: - array - 'null' items: type: string x-go-name: WarningMessages x-go-package: cohesity/iris/server/data/public GcpCredentials: description: Specifies the credentials to authenticate with Google Cloud Platform. type: object title: GCP source Credentials. properties: clientEmailAddress: description: Specifies Client email address associated with the service account. type: - string - 'null' x-go-name: ClientEmailAddress clientPrivateKey: description: Specifies Client private associated with the service account. type: - string - 'null' x-go-name: ClientPrivateKey gcpType: description: 'Specifies the entity type such as ''kIAMUser'' if the environment is kGCP. Specifies the type of a GCP source entity. ''kIAMUser'' indicates a unique user within a GCP account. ''kProject'' represents compute resources and storage. ''kRegion'' indicates a geographical region in the global infrastructure. ''kAvailabilityZone'' indicates an availability zone within a region. ''kVirtualMachine'' indicates a Virtual Machine running in GCP environment. ''kVPC'' indicates a virtual private cloud (VPC) network within GCP. ''kSubnet'' indicates a subnet inside the VPC. ''kNetworkSecurityGroup'' represents a network security group. ''kInstanceType'' represents various machine types. ''kLabel'' represents a label present on the instances. ''kMetaData'' represents a custom metadata present on instances. ''kTag'' represents a network tag on instances. ''kVPCConnector'' represents a VPC connector used for serverless VPC access.' type: - string - 'null' enum: - kIAMUser - kProject - kRegion - kAvailabilityZone - kVirtualMachine - kVPC - kSubnet - kNetworkSecurityGroup - kInstanceType - kLabel - kMetadata - kTag - kVPCConnector x-go-name: GcpType projectId: description: Specifies Id of the project associated with Google cloud account. type: - string - 'null' x-go-name: ProjectId vpcNetwork: description: Specifies the VPC Network to deploy proxy VMs. type: - string - 'null' x-go-name: VpcNetwork vpcSubnetwork: description: Specifies the subnetwork to deploy proxy VMs. type: - string - 'null' x-go-name: VpcSubnetwork x-go-package: cohesity/iris/server/data/public SslVerification: description: 'Specifies information about SSL verification when registering certain sources.' type: object title: SSL certification verification settings. properties: caCertificate: description: Contains the contents of CA cert/cert chain. type: - string - 'null' x-go-name: CaCertificate isEnabled: description: Whether SSL verification should be performed. type: - boolean - 'null' x-go-name: IsEnabled x-go-package: cohesity/iris/server/data/public IsilonNfsMountPoint: description: Specifies NFS Mount Point exposed by Isilon Protection Source. type: object title: Isilon NFS Mount Point. properties: accessZoneName: description: Specifies the Access Zone name. type: - string - 'null' x-go-name: AccessZoneName description: description: Specifies the description of the NFS mount point. type: - string - 'null' x-go-name: Description id: description: Specifies the Id of the NFS export. type: - integer - 'null' format: int64 x-go-name: Id x-go-package: cohesity/iris/server/data/public FlashBladeStorageArray: description: Specifies information about a Pure Storage FlashBlade Array. type: object title: Flash Blade Storage Array. properties: capacityBytes: description: 'Specifies the total capacity in bytes of the Pure Storage FlashBlade Array.' type: - integer - 'null' format: int64 x-go-name: CapacityBytes id: description: 'Specifies a unique id of a Pure Storage FlashBlade Array. The id is unique across Cohesity Clusters.' type: - string - 'null' x-go-name: Id networks: description: Specifies the network interfaces of the Pure Storage FlashBlade Array. type: - array - 'null' items: $ref: '#/components/schemas/FlashBladeNetworkInterface' x-go-name: Networks physicalUsedBytes: description: Specifies the space used for physical data in bytes. type: - integer - 'null' format: int64 x-go-name: PhysicalUsedBytes revision: description: Specifies the revision of the Pure Storage FlashBlade software. type: - string - 'null' x-go-name: Revision version: description: 'Specifies the software version running on the Pure Storage FlashBlade Array.' type: - string - 'null' x-go-name: Version x-go-package: cohesity/iris/server/data/public CopyRunStats: description: 'Stats for one copy task or aggregated stats of a Copy Run in a Protection Job Run.' type: object properties: endTimeUsecs: description: 'Specifies the time when this replication ended. If not set, then the replication has not ended yet.' type: - integer - 'null' format: int64 x-go-name: EndTimeUsecs isIncremental: description: Specifies whether this archival is incremental for archival targets. type: - boolean - 'null' x-go-name: IsIncremental logicalBytesTransferred: description: 'Specifies the number of logical bytes transferred for this replication so far. This value can never exceed the total logical size of the replicated view.' type: - integer - 'null' format: int64 x-go-name: LogicalBytesTransferred logicalSizeBytes: description: 'Specifies the total amount of logical data to be transferred for this replication.' type: - integer - 'null' format: int64 x-go-name: LogicalSizeBytes logicalTransferRateBps: description: 'Specifies average logical bytes transfer rate in bytes per second for archchival targets.' type: - integer - 'null' format: int64 x-go-name: LogicalTransferRateBps physicalBytesTransferred: description: 'Specifies the number of physical bytes sent over the wire for replication targets.' type: - integer - 'null' format: int64 x-go-name: PhysicalBytesTransferred startTimeUsecs: description: 'Specifies the time when this replication was started. If not set, then replication has not been started yet.' type: - integer - 'null' format: int64 x-go-name: StartTimeUsecs x-go-package: cohesity/iris/server/data/public HiveTable: description: Specifies an Object containing information about a Hive table. type: object title: Hive Table Info. properties: approxSizeBytes: description: Specifies the approx size of the table in bytes. type: - integer - 'null' format: int64 x-go-name: ApproxSizeBytes createdOn: description: Specifies the created on, epoch millis. type: - integer - 'null' format: int64 x-go-name: CreatedOn isTransactionalTable: description: Specifies if this is a transactional table. type: - boolean - 'null' x-go-name: IsTransactionalTable owner: description: Specifies the owner of the table. type: - string - 'null' x-go-name: Owner tableType: description: 'Specifies the type of table ex. MANAGED,VIRTUAL etc. Specifies the type of an Hive table. ''kManaged'' indicates a MANAGED Hive table. ''kExternal'' indicates a EXTERNAL Hive table. ''kVirtual'' indicates a VIRTUAL Hive tablet. ''kIndex'' indicates a INDEX Hive table.' type: - string - 'null' enum: - kManaged - kExternal - kVirtual - kIndex x-go-name: TableType x-go-package: cohesity/iris/server/data/public AdProtectionSource: description: Specifies an object representing an AD entity. type: object title: AD Protection Source. properties: domainController: description: Specifies the domain controller residing in this physical machine. $ref: '#/components/schemas/AdDomainController' domainName: description: Specifies the domain name corresponding to the domain controller. type: - string - 'null' x-go-name: DomainName name: description: Specifies the domain name of the AD entity. type: - string - 'null' x-go-name: Name ownerId: description: Specifies the entity id of the owner entity. type: - integer - 'null' format: int64 x-go-name: OwnerId type: description: 'Specifies the type of the managed object in AD Protection Source. Specifies the kind of AD protection source. ''kRootContainer'' indicates the entity is a root container to an AD domain controller. ''kDomainController'' indicates the domain controller hosted in this physical server.' type: - string - 'null' enum: - kRootContainer - kDomainController x-go-name: Type uuid: description: Specifies the UUID for the AD entity. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public ProtectionJobRunStats: description: 'Specifies statistics about a Protection Job Run. This contains the Job Run level statistics.' type: object title: Protection Job Run Statistics. properties: admittedTimeUsecs: description: 'Specifies the time the task was unqueued from the queue to start running. This field can be used to determine the following times: initial-wait-time = admittedTimeUsecs - startTimeUsecs run-time = endTimeUsecs - admittedTimeUsecs If the task ends up waiting in other queues, then actual run-time will be smaller than the run-time computed this way. This field is only populated for Backup tasks currently.' type: - integer - 'null' format: int64 x-go-name: AdmittedTimeUsecs endTimeUsecs: description: 'Specifies the end time of the Protection Run. The end time is specified as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: EndTimeUsecs numAppInstances: description: 'Specifies the number of application instances backed up by this Run. For example if the environment type is kSQL, this field contains the number of SQL Server instances.' type: - integer - 'null' format: int32 x-go-name: NumAppInstances numCanceledTasks: description: Specifies the number of backup tasks that were canceled. type: - integer - 'null' format: int64 x-go-name: NumCanceledTasks numCancelledAppObjects: description: 'Specifies the number of application objects that were cancelled in this Run.' type: - integer - 'null' format: int32 x-go-name: NumCancelledAppObjects numFailedAppObjects: description: Specifies the number of application objects that failed in this Run. type: - integer - 'null' format: int32 x-go-name: NumFailedAppObjects numFailedTasks: description: Specifies the number of backup tasks that failed. type: - integer - 'null' format: int64 x-go-name: NumFailedTasks numSuccessfulAppObjects: description: 'Specifies the number of application objects successfully backed up by this Run. For example, if the environment type is kSQL, this number is for all of the SQL server databases.' type: - integer - 'null' format: int32 x-go-name: NumSuccessfulAppObjects numSuccessfulTasks: description: Specifies the number of backup tasks that completed successfully. type: - integer - 'null' format: int64 x-go-name: NumSuccessfulTasks startTimeUsecs: description: 'Specifies the start time of the Protection Run. The start time is specified as a Unix epoch Timestamp (in microseconds). This time is when the task is queued to an internal queue where tasks are waiting to run.' type: - integer - 'null' format: int64 x-go-name: StartTimeUsecs timeTakenUsecs: description: 'Specifies the actual execution time for the protection run to complete the backup task and the copy tasks. This time will not include the time waited in various internal queues. This field is only populated for Backup tasks currently.' type: - integer - 'null' format: int64 x-go-name: TimeTakenUsecs totalBytesReadFromSource: description: Specifies the total amount of data read from the source (so far). type: - integer - 'null' format: int64 x-go-name: TotalBytesReadFromSource totalBytesToReadFromSource: description: 'Specifies the total amount of data expected to be read from the source.' type: - integer - 'null' format: int64 x-go-name: TotalBytesToReadFromSource totalLogicalBackupSizeBytes: description: 'Specifies the size of the source object (such as a VM) protected by this task on the primary storage after the snapshot is taken. The logical size of the data on the source if the data is fully hydrated or expanded and not reduced by change-block tracking, compression and deduplication.' type: - integer - 'null' format: int64 x-go-name: TotalLogicalBackupSizeBytes totalPhysicalBackupSizeBytes: description: 'Specifies the total amount of physical space used on the Cohesity Cluster to store the protected object after being reduced by change-block tracking, compression and deduplication. For example, if the logical backup size is 1GB, but only 1MB was used on the Cohesity Cluster to store it, this field be equal to 1MB.' type: - integer - 'null' format: int64 x-go-name: TotalPhysicalBackupSizeBytes totalSourceSizeBytes: description: 'Specifies the size of the source object (such as a VM) protected by this task on the primary storage before the snapshot is taken. The logical size of the data on the source if the data is fully hydrated or expanded and not reduced by change-block tracking, compression and deduplication.' type: - integer - 'null' format: int64 x-go-name: TotalSourceSizeBytes x-go-package: cohesity/iris/server/data/public MongoDBCollection: description: Specifies an Object containing information about a mongodb collection. type: object title: MongoDB Collection Info. properties: isCappedCollection: description: Set to true if this is a capped Collection. type: - boolean - 'null' x-go-name: IsCappedCollection isMongoView: description: Set to true if this Collection is a view. type: - boolean - 'null' x-go-name: IsMongoView sizeBytes: description: Size of this Collection. type: - integer - 'null' format: int64 x-go-name: SizeBytes x-go-package: cohesity/iris/server/data/public KvmProtectionSource: description: Specifies a Protection Source in KVM environment. type: object title: KVM Protection Source. properties: agentError: description: Specifies a message when the agent cannot be reached. type: - string - 'null' x-go-name: AgentError agentId: description: 'Specifies the ID of the Agent with which this KVM entity is associated when the entity represents a Delegate host or KVM host.' type: - integer - 'null' format: int64 x-go-name: AgentId clusterId: description: Specifies the cluster ID for 'kCluster' objects. type: - string - 'null' x-go-name: ClusterId datacenterId: description: Specifies the ID of the 'kDatacenter' objects. type: - string - 'null' x-go-name: DatacenterId description: description: Specifies a description about the Protection Source. type: - string - 'null' x-go-name: Description name: description: Specifies the name of the KVM entity. type: - string - 'null' x-go-name: Name networkId: description: Specifies the network ID to which Vnic is attached. type: - string - 'null' x-go-name: NetworkId type: description: 'Specifies the type of KVM Protection Source entities such as ''kDatacenter'', ''kCluster'', ''kVirtualMachine'', etc. Specifies the type of an KVM source entity. ''kOVirtManager'' indicates the root entity registered with Cohesity cluster. ''kStandaloneHost'' indicates a host registered with Cohesity cluster. ''kDatacenter'' indicates a KVM datacenter managed by the OVirt manager. ''kCluster'' indicates a KVM cluster managed by the OVirt manager. ''kHost'' indicates a host within the KVM environment. ''kVirtualMachine'' indicates a virtual machine in the KVM enironment. ''kNetwork'' represents a network used by the virtual machine entity. ''kStorageDomain'' represents a storage domain in the KVM environment. ''kVNicProfile'' represents a VNic profile.' type: - string - 'null' enum: - kOVirtManager - kStandaloneHost - kDatacenter - kCluster - kHost - kVirtualMachine - kNetwork - kStorageDomain - kVNicProfile x-go-name: Type uuid: description: 'Specifies the UUID of the Object. This is unique within the KVM environment.' type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public FleetTag: description: Specfies the key,value pair for the fleet tag. type: object title: Fleet Tag Parameters. properties: key: description: Specifies the key for the fleet tag. type: - string - 'null' x-go-name: Key value: description: Specifies the value for the fleet tag. type: - string - 'null' x-go-name: Value x-go-package: cohesity/iris/server/data/public 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 IscsiSanPort: description: Specifies an iSCSI SAN Port. type: object title: ISCSI SAN Port. properties: ipAddress: description: Specifies the IP address of the SAN port. type: - string - 'null' x-go-name: IpAddress iqn: description: Specifies the qualified name of the iSCSI port (IQN). type: - string - 'null' x-go-name: Iqn tcpPort: description: Specifies the listening port(tcp) of the SAN port. type: - integer - 'null' format: int32 x-go-name: TcpPort x-go-package: cohesity/iris/server/data/public OracleEnvJobParameters: description: 'Specifies job parameters applicable for all ''kOracle'' Environment type Protection Sources in a Protection Job.' type: object title: Oracle Environment Job Parameters. properties: persistMountpoints: description: 'Specifies whether the mountpoints created while backing up Oracle DBs should be persisted. 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: cohesity/iris/server/data/public IpDetails: description: 'Entity Type | IP Address Details | Details field kHostSystem | VMKernel Adapter IP Addresses | VMKernelAdapter TODO(Matthew) : Use an enum for the ''Details''.' type: object title: 'IP address details The table below captures the type if information published by an entity type using this field.' properties: details: description: Details of the IP Addresses captured below type: - string - 'null' x-go-name: Details ipAddresses: description: The IP Addresses type: - array - 'null' items: type: string x-go-name: IpAddresses x-go-package: cohesity/iris/server/data/public ElastifileContainer: description: Specifies information about container in an Elastifile Cluster. type: object title: Elastifile Container. properties: createdAt: description: Specifies the creation date of the container. type: - string - 'null' x-go-name: CreatedAt id: description: Specifies id of a Elastifile Container in a Cluster. type: - integer - 'null' format: int32 x-go-name: Id isNfsInterface: description: Specifies if the container has NFS volumes or not. type: - boolean - 'null' x-go-name: IsNfsInterface isSmbInterface: description: Specifies if the container has SMB volumes or not. type: - boolean - 'null' x-go-name: IsSmbInterface name: description: Specifies the name of the container. type: - string - 'null' x-go-name: Name protocols: description: 'Specifies Elastifile supported Protocol information enabled on Elastifile container. ''kNfs'' indicates NFS protocol in an elastifile container. ''kSmb'' indicates SMB protocol in an elastifile container.' type: - array - 'null' items: type: string enum: - kNfs - kSmb x-go-name: Protocols usedBytes: description: Specifies the bytes used by the container. type: - integer - 'null' format: int64 x-go-name: UsedBytes uuid: description: Specifies the UUID of the container. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public ElastifileCluster: description: Specifies information about a Elastifile Cluster. type: object title: Elastifile Cluster. properties: enodeIpAddressVec: description: IP addresses of Elastifile nodes. type: - array - 'null' items: type: string x-go-name: ElastifileNodeIps loadBalancerVip: description: Specifies the load balancer VIP if present. type: - string - 'null' x-go-name: LoadBalancerVip name: description: Specifies name of a Elastifile Cluster type: - string - 'null' x-go-name: Name uuid: description: Specifies the UUID of a Elastifile Cluster. type: - string - 'null' x-go-name: Uuid version: description: Specifies the version of a Elastifile Cluster. type: - string - 'null' x-go-name: Version x-go-package: cohesity/iris/server/data/public GpfsProtectionSource: description: Specifies a Protection Source in GPFS environment. type: object title: GPFS Protection Source. properties: cluster: description: 'Specifies information of an GPFS Cluster. This is set only when the entity type is ''kCluster''.' $ref: '#/components/schemas/GpfsCluster' fileset: description: 'Specifies information about a mount point in an GPFS file system. This is set only when the entity type is ''kFileset''.' $ref: '#/components/schemas/GpfsFileset' filesystem: description: 'Specifies an access zone in an GPFS file system. This is set only when the entity type is ''kFilesystem''.' $ref: '#/components/schemas/GpfsFilesystem' name: description: Specifies a unique name of the Protection Source. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of the entity in an GPFS file system like ''kCluster'', ''kFilesystem'', or, ''kFileset''. ''kCluster'' indicates an GPFS Cluster. ''kFilesystem'' indicates a top level filesystem on GPFS cluster. ''kFileset'' indicates a fileset within a filesystem.' type: - string - 'null' enum: - kCluster - kFilesystem - kFileset x-go-name: Type x-go-package: cohesity/iris/server/data/public AwsCredentials: description: Specifies the credentials to authenticate with AWS Cloud Platform. type: object title: AWS source Credentials. properties: accessKey: description: Specifies Access key of the AWS account. type: - string - 'null' x-go-name: AccessKey amazonResourceName: description: 'Specifies Amazon Resource Name (owner ID) of the IAM user, act as an unique identifier of as AWS entity.' type: - string - 'null' x-go-name: AmazonResourceName authMethod: description: 'Specifies the authentication method to be used for API calls. Specifies the authentication method to be used for API calls. ''kUseIAMUser'' indicates a user based authentication. ''kUseIAMRole'' indicates a role based authentication, used only for AWS CE.' type: - string - 'null' enum: - kUseIAMUser - kUseIAMRole x-go-name: AuthMethod awsType: description: 'Specifies the entity type such as ''kIAMUser'' if the environment is kAWS. Specifies the type of an AWS source entity. ''kIAMUser'' indicates a unique user within an AWS account. ''kRegion'' indicates a geographical region in the global infrastructure. ''kAvailabilityZone'' indicates an availability zone within a region. ''kEC2Instance'' indicates a Virtual Machine running in AWS environment. ''kVPC'' indicates a virtual private cloud (VPC) network within AWS. ''kSubnet'' indicates a subnet inside the VPC. ''kNetworkSecurityGroup'' represents a network security group. ''kInstanceType'' represents various machine types. ''kKeyPair'' represents a pair of public and private key used to login into a Virtual Machine. ''kTag'' represents a tag attached to EC2 instance. ''kRDSOptionGroup'' represents a RDS option group for configuring database features. ''kRDSParameterGroup'' represents a RDS parameter group. ''kRDSInstance'' represents a RDS DB instance. ''kRDSSubnet'' represents a RDS subnet. ''kRDSTag'' represents a tag attached to RDS instance.' type: - string - 'null' enum: - kIAMUser - kRegion - kAvailabilityZone - kEC2Instance - kVPC - kSubnet - kNetworkSecurityGroup - kInstanceType - kKeyPair - kTag - kRDSOptionGroup - kRDSParameterGroup - kRDSInstance - kRDSSubnet - kRDSTag x-go-name: AwsType iamRoleArn: description: 'Specifies the IAM role which will be used to access the security credentials required for API calls.' type: - string - 'null' x-go-name: IamRoleArn secretAccessKey: description: Specifies Secret Access key of the AWS account. type: - string - 'null' x-go-name: SecretAccessKey subscriptionType: description: 'Specifies the subscription type of AWS such as ''kAWSCommercial'' or ''kAWSGovCloud''. Specifies the subscription type of an AWS source entity. ''kAWSCommercial'' indicates a standard AWS subscription. ''kAWSGovCloud'' indicates a govt AWS subscription.' type: - string - 'null' enum: - kAWSCommercial - kAWSGovCloud x-go-name: SubscriptionType x-go-package: cohesity/iris/server/data/public AagAndDatabases: description: Specifies an AAG and the database members of the AAG. type: object title: AAG And Databases. properties: aag: description: Specifies an AAG Protection Source object on a VM or a Physical host. $ref: '#/components/schemas/ProtectionSource' databases: description: Specifies databases found that are members of the AAG. type: - array - 'null' items: $ref: '#/components/schemas/ProtectionSource' x-go-name: Databases x-go-package: cohesity/iris/server/data/public CassandraKeyspace: description: Specifies an Object containing information about a Cassandra Keyspace. type: object title: Cassandra Keyspace Info. properties: childrenCount: description: Number of documents in this bucket. type: - integer - 'null' format: uint32 x-go-name: ChildrenCount dcList: description: 'If the replication strategy is set as kNetwork, then dc_list will have a list of data centers to which the keyspace is being replicated to.' type: - array - 'null' items: type: string x-go-name: DcList replicationStrategy: description: 'Replication stragegy for the keyspace. Specifies the type of an Cassandra source entity.' type: - string - 'null' enum: - kSimple - kNetwork - kUnsupported x-go-name: ReplicationStrategy x-go-package: cohesity/iris/server/data/public DownloadCftParams: type: object title: Structure to get the CFT/Json file. properties: fileName: description: Specifies the file name of the cloud formation template. type: - string - 'null' x-go-name: FileName filePath: description: 'Specifies the file path of the template. If passed null, "/home/cohesity/bin" will be considered as file path.' type: - string - 'null' x-go-name: FilePath x-go-package: cohesity/iris/server/data/public AwsParams: description: Specifies various resources when converting and deploying a VM to AWS. type: object title: AWS Parameters. properties: instanceId: description: Specifies id of the AWS instance type in which to deploy the VM. type: - integer - 'null' format: int64 x-go-name: InstanceId networkSecurityGroupIds: description: Specifies ids of the network security groups within above VPC. type: - array - 'null' items: type: integer format: int64 x-go-name: NetworkSecurityGroupIds rdsParams: description: Specifies Amazon RDS parameters. $ref: '#/components/schemas/RdsParams' region: description: Specifies id of the AWS region in which to deploy the VM. type: - integer - 'null' format: int64 x-go-name: Region subnetId: description: Specifies id of the subnet within above VPC. type: - integer - 'null' format: int64 x-go-name: SubnetId virtualPrivateCloudId: description: Specifies id of the Virtual Private Cloud to chose for the instance type. type: - integer - 'null' format: int64 x-go-name: VirtualPrivateCloudId x-go-package: cohesity/iris/server/data/public PureProtectionSource: description: Specifies a Protection Source in a Pure environment. type: object title: Pure Protection Source. properties: name: description: Specifies a unique name of the Protection Source type: - string - 'null' x-go-name: Name storageArray: description: 'Specifies a SAN Storage Array information. This is set only when the type is kStorageArray.' $ref: '#/components/schemas/SanStorageArray' type: description: 'Specifies the type of managed Object in a SAN/Pure Protection Source like a kStorageArray or kVolume. Examples of SAN Objects include ''kStorageArray'' and ''kVolume''. ''kStorageArray'' indicates that entire SAN storage array is being protected. ''kVolume'' indicates that volume within the array is being protected.' type: - string - 'null' enum: - kStorageArray - kVolume x-go-name: Type volume: description: 'Specifies a SAN Volume information within a storage array. This is set only when the type is kVolume.' $ref: '#/components/schemas/SanVolume' x-go-package: cohesity/iris/server/data/public ProtectionSummaryByEnv: description: 'ProtectionSummaryByEnv specifies the number of protected and unprotected objects that is break down by environment.' type: object title: Protection Summary By Environment. properties: environment: description: 'Specifies the type of environment of the source object like kSQL etc. Supported environment types such as ''kView'', ''kSQL'', ''kVMware'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter. ''kVMware'' indicates the VMware Protection Source environment. ''kHyperV'' indicates the HyperV Protection Source environment. ''kSQL'' indicates the SQL Protection Source environment. ''kView'' indicates the View Protection Source environment. ''kPuppeteer'' indicates the Cohesity''s Remote Adapter. ''kPhysical'' indicates the physical Protection Source environment. ''kPure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''kAzure'' indicates the Microsoft''s Azure Protection Source environment. ''kNetapp'' indicates the Netapp Protection Source environment. ''kAgent'' indicates the Agent Protection Source environment. ''kGenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''kAcropolis'' indicates the Acropolis Protection Source environment. ''kPhsicalFiles'' indicates the Physical Files Protection Source environment. ''kIsilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''kGPFS'' indicates IBM''s GPFS Protection Source environment. ''kKVM'' indicates the KVM Protection Source environment. ''kAWS'' indicates the AWS Protection Source environment. ''kExchange'' indicates the Exchange Protection Source environment. ''kHyperVVSS'' indicates the HyperV VSS Protection Source environment. ''kOracle'' indicates the Oracle Protection Source environment. ''kGCP'' indicates the Google Cloud Platform Protection Source environment. ''kFlashBlade'' indicates the Flash Blade Protection Source environment. ''kAWSNative'' indicates the AWS Native Protection Source environment. ''kO365'' indicates the Office 365 Protection Source environment. ''kO365Outlook'' indicates Office 365 outlook Protection Source environment. ''kHyperFlex'' indicates the Hyper Flex Protection Source environment. ''kGCPNative'' indicates the GCP Native Protection Source environment. ''kAzureNative'' indicates the Azure Native Protection Source environment. ''kKubernetes'' indicates a Kubernetes Protection Source environment. ''kElastifile'' indicates Elastifile Protection Source environment. ''kAD'' indicates Active Directory Protection Source environment. ''kRDSSnapshotManager'' indicates AWS RDS Protection Source environment. ''kCassandra'' indicates Cassandra Protection Source environment. ''kMongoDB'' indicates MongoDB Protection Source environment. ''kCouchbase'' indicates Couchbase Protection Source environment. ''kHdfs'' indicates Hdfs Protection Source environment. ''kHive'' indicates Hive Protection Source environment. ''kHBase'' indicates HBase Protection Source environment.' type: - string - 'null' enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kNimble - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kAzureNative - kKubernetes - kElastifile - kAD - kRDSSnapshotManager - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase x-go-name: Environment protectedCount: description: 'Specifies the number of objects that are protected under the given entity.' type: - integer - 'null' format: int64 x-go-name: ProtectedCount protectedSize: description: Specifies the total size of the protected objects under the given entity. type: - integer - 'null' format: int64 x-go-name: ProtectedSize unprotectedCount: description: 'Specifies the number of objects that are not protected under the given entity.' type: - integer - 'null' format: int64 x-go-name: UnprotectedCount unprotectedSize: description: 'Specifies the total size of the unprotected objects under the given entity.' type: - integer - 'null' format: int64 x-go-name: UnprotectedSize x-go-package: cohesity/iris/server/data/public Office365ProtectionSource: description: Specifies a Protection Source in Office 365 environment. type: object title: Office 365 Protection Source. properties: description: description: Specifies the description of the Office 365 entity. type: - string - 'null' x-go-name: Description name: description: Specifies the name of the office 365 entity. type: - string - 'null' x-go-name: Name primarySMTPAddress: description: Specifies the SMTP address for the Outlook source. type: - string - 'null' x-go-name: PrimarySMTPAddress type: description: 'Specifies the type of the Office 365 entity. Specifies the type of Office 365 entity ''kDomain'' indicates the O365 domain through which authentication occurs. ''kOutlook'' indicates the Exchange online entities. ''kMailbox'' indicates the user''s mailbox account. ''kUsers'' indicates the container for User entities. ''kGroups'' indicates the container for Group entities. ''kSites'' indicates the container for Site entities. ''kUser'' indicates an Office365 User entity. ''kGroup'' indicates an Office365 Group entity. ''kSite'' indicates an Office365 SharePoint Site entity.' type: - string - 'null' enum: - kDomain - kOutlook - kMailbox - kUsers - kGroups - kSites - kUser - kGroup - kSite x-go-name: Type userInfo: description: 'Specifies the information about Office365 user regarding its Mailbox & OneDrive. This is only present if the entity type is a User.' $ref: '#/components/schemas/Office365UserInfo' uuid: description: Specifies the UUID of the Office 365 entity. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public 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 NasEnvJobParameters: description: 'Specifies job parameters applicable for all ''kGenericNas'' Environment type Protection Sources in a Protection Job.' type: object title: NAS Environment Job Parameters. properties: continueOnError: description: 'Specifies if the backup should continue on with other Protection Sources even if the backup operation of some Protection Source fails. If true, the Cohesity Cluster ignores the errors and continues with remaining Protection Sources in the job. If false, the backup operation stops when an error occurs. This does not apply to non-snapshot based generic NAS backup jobs. If not set, default value is true.' type: - boolean - 'null' x-go-name: ContinueOnError dataMigrationJobParameters: description: 'Specifies additional parameters that are applicable only to the data migration jobs in NAS environment.' $ref: '#/components/schemas/DataMigrationJobParameters' dataUptierJobParameters: description: 'Specifies additional parameters that are applicable only to the data uptier jobs in NAS environment.' $ref: '#/components/schemas/DataUptierJobParameters' enableFasterIncrementalBackups: description: 'Specifies whether this job will enable faster incremental backups using change list or similar APIs' type: - boolean - 'null' x-go-name: EnableFasterIncrementalBackups encryptionEnabled: description: Specifies if the protection job should use encryption while backing up type: - boolean - 'null' x-go-name: EncryptionEnabled fileLockConfig: description: 'Optional config that enables file locking for this job. It cannot be disabled during the edit of a job, if it has been enabled during the creation of the job. Also, it cannot be enabled if it was disabled during the creation of the job.' $ref: '#/components/schemas/FileLevelDataLockConfig' filePathFilters: description: 'Specifies filters on the backup objects like files and directories. Specifying filters decide which objects within a source should be backed up. If this field is not specified, then all of the objects within the source will be backed up.' $ref: '#/components/schemas/FilePathFilter' nasProtocol: description: 'Specifies the preferred protocol to use for backup. This does not apply to generic NAS and will be ignored. Specifies the protocol used by a NAS server. ''kNfs3'' indicates NFS v3 protocol. ''kCifs1'' indicates CIFS v1.0 protocol.' type: - string - 'null' enum: - kNfs3 - kCifs1 x-go-name: NasProtocol snapshotLabel: description: 'Specifies the incremental and full snapshot label for Data-Protect Netapp Volumes backup. If field is set , incremental and full snapshot label has to be provided. If field is not set, the snapshot label will be automatically set using timestamp.' $ref: '#/components/schemas/SnapshotLabel' x-go-package: cohesity/iris/server/data/public FlashBladeProtectionSource: description: Specifies a Protection Source in Pure Storage FlashBlade environment. type: object title: Pure Storage FlashBlade Protection Source. properties: fileSystem: description: 'Specifies a Pure Storage FlashBlade File System information. This is set only when the object type is ''kFileSystem''.' $ref: '#/components/schemas/FlashBladeFileSystem' name: description: Specifies a unique name of the Protection Source. type: - string - 'null' x-go-name: Name storageArray: description: 'Specifies a Pure Storage FlashBlade Array information. This is set only when the object type is ''kStorageArray''.' $ref: '#/components/schemas/FlashBladeStorageArray' type: description: 'Specifies the type of managed object in a Pure Storage FlashBlade like ''kStorageArray'' or ''kFileSystem''. ''kStorageArray'' indicates a top level Pure Storage FlashBlade array. ''kFileSystem'' indicates a Pure Storage FlashBlade file system within the array.' type: - string - 'null' enum: - kStorageArray - kFileSystem x-go-name: Type x-go-package: cohesity/iris/server/data/public DataMigrationPolicy: description: 'Specifies settings for data migration in NAS environment. This also specifies the retention policy that should be applied to files after they have been moved to cohesity cluster.' type: object title: Data Migration Policy. properties: daysToKeep: description: Specifies how many days to retain Snapshots on the Cohesity Cluster. type: - integer - 'null' format: int64 x-go-name: DaysToKeep schedulingPolicy: description: Specifies schedule for the data migration job. $ref: '#/components/schemas/SchedulingPolicy' wormRetentionType: description: 'Specifies WORM retention type for the files. When a WORM retention type is specified, the files will be kept until the maximum of the retention time. During that time, the files cannot be deleted. ''kNone'' implies there is no WORM retention set. ''kCompliance'' implies WORM retention is set for compliance reason. ''kAdministrative'' implies WORM retention is set for administrative purposes.' type: - string - 'null' enum: - kNone - kCompliance - kAdministrative x-go-name: WormRetentionType x-go-package: cohesity/iris/server/data/public MongoDBConnectParams: description: 'Specifies an Object containing information about a registered mongodb source.' type: object title: MongoDB Connect Params. properties: authType: description: 'Specifies whether authentication is configured on this MongoDB cluster. Specifies the type of an MongoDB source entity. ''SCRAM'' ''LDAP'' ''NONE''' type: - string - 'null' enum: - SCRAM - LDAP - NONE x-go-name: AuthType authenticatingDatabaseName: description: Specifies the Authenticating Database for this MongoDB cluster. type: - string - 'null' x-go-name: AuthenticatingDatabaseName requiresSsl: description: Specifies whether connection is allowed through SSL only in this cluster. type: - boolean - 'null' x-go-name: RequiresSsl secondaryNodeTag: description: 'MongoDB Secondary node tag. Required only if ''useSecondaryForBackup'' is true. The system will use this to identify the secondary nodes for reading backup data.' type: - string - 'null' x-go-name: SecondaryNodeTag seeds: description: Specifies the seeds of this MongoDB Cluster. type: - array - 'null' items: type: string x-go-name: Seeds useSecondaryForBackup: description: Set this to true if you want the system to peform backups from secondary nodes. type: - boolean - 'null' x-go-name: UseSecondaryForBackup x-go-package: cohesity/iris/server/data/public DiskUnit: description: Specifies information about a disk unit in a controller. type: object title: Disk Unit. properties: busNumber: description: Specifies the Id of the controller bus that controls the disk. type: - integer - 'null' format: int64 x-go-name: BusNumber controllerType: description: Specifies the controller type like SCSI, or IDE etc. type: - string - 'null' x-go-name: ControllerType unitNumber: description: 'Specifies the disk file name. This is the VMDK name and not the flat file name.' type: - integer - 'null' format: int64 x-go-name: UnitNumber x-go-package: cohesity/iris/server/data/public ExchangeDatabaseCopyInfo: description: 'Specifies the information about the copy of the Exchange Database on particular Exchange Application Server that is part of DAG.' type: object title: Exchange Database Copy Information properties: activationPreferenceNumber: description: 'Specifies the activation preference number assigned for this database copy.' type: - integer - 'null' format: uint32 x-go-name: ActivationPreferenceNumber appServerId: description: 'Specifies the entity id of the Exchange Application Server which has this database copy.' type: - integer - 'null' format: int64 x-go-name: AppServerId backupSupported: description: Specifies if backup is supported for the Exchange database copy. type: - boolean - 'null' x-go-name: BackupSupported backupUnsupportedReasons: description: Specifies any reason(s) for Exchange database backup not supported. type: - array - 'null' items: type: string x-go-name: BackupUnsupportedReasons copyGuid: description: Specifies the Guid of the Exchange Database Copy. type: - string - 'null' x-go-name: CopyGuid createdTimeMsecs: description: 'Specifies the time when the database is created in Unix epoch time in milliseconds.' type: - integer - 'null' format: int64 x-go-name: CreatedTimeMsecs databaseState: description: 'Specifies the state of the Exchange database copy. Specifies the state of Exchange Database Copy. ''kUnknown'' indicates the status is not known. ''kMounted'' indicates the exchange database copy is mounted and healthy. ''kError'' indicates the exchange database copy is unmounted or partially mounted or is in error state.' type: - string - 'null' enum: - kUnknown - kMounted - kError x-go-name: DatabaseState dbSizeBytes: description: Specifies the size of the Exchange database copy in bytes. type: - integer - 'null' format: int64 x-go-name: DbSizeBytes dbguid: description: Specifies the guid of the Exchange Database. type: - string - 'null' x-go-name: DbGuid fqdn: description: 'Specifies the fully qualified domain name of the Exchange Server on which the database copy is hosted.' type: - string - 'null' x-go-name: Fqdn isActiveCopy: description: 'Specifies if the Exchange database copy present on the Exchange Application server is active or passive.' type: - boolean - 'null' x-go-name: ActiveCopy name: description: Specifes the name of the Exchange Database. type: - string - 'null' x-go-name: Name ownerId: description: 'Specifies the owner entity id of the Exchange Application Server which has this database copy.' type: - integer - 'null' format: int64 x-go-name: OwnerId serverName: description: 'Specifies the display name of the Exchange Application Server on which the database copy is hosted.' type: - string - 'null' x-go-name: ServerName utcOffsetMin: description: Specifies UTC time offset of database creation time. type: - integer - 'null' format: int64 x-go-name: UtcOffsetMin x-go-package: cohesity/iris/server/data/public AppEntityBackupStatusInfo: description: Specifies the app level backup status and information. type: object title: App Entity Backup State Info properties: appId: description: 'Specifies the Id of the App entity. This is typically a database entity in case of SQL, Oracle jobs etc.' type: - integer - 'null' format: int64 x-go-name: AppId error: description: 'Specifies if an error occurred (if any) while running this task. This field is populated when the status is equal to ''kFailure''.' type: - string - 'null' x-go-name: Error name: description: Specifies the name of the app entity. type: - string - 'null' x-go-name: Name ownerId: description: 'Specifies the owner id of the the app. Owner is the host under which the app is located. Example: SQL DB entities can be hosted by Physical host or virtual machine.' type: - integer - 'null' format: int64 x-go-name: OwnerId status: description: 'Specifies the backup status for this app entity. ''kAccepted'' indicates the task is queued to run but not yet running. ''kRunning'' indicates the task is running. ''kCanceling'' indicates a request to cancel the task has occurred but the task is not yet canceled. ''kCanceled'' indicates the task has been canceled. ''kSuccess'' indicates the task was successful. ''kFailure'' indicates the task failed. ''kWarning'' indicates the task has finished with warning. ''kOnHold'' indicates the task is kept onHold. ''kMissed'' indicates the task is missed.' type: - string - 'null' enum: - kAccepted - kRunning - kCanceling - kCanceled - kSuccess - kFailure - kWarning - kOnHold - kMissed x-go-name: Status warnings: description: Specifies the warnings that occurred (if any) while running this task. type: - array - 'null' items: type: string x-go-name: Warnings x-go-package: cohesity/iris/server/data/public GpfsFilesystem: description: Specifies information about filesystem in a GPFS Cluster. type: object title: GPFS Filesystem. properties: id: description: Specifies the id of the file system. type: - string - 'null' x-go-name: Id path: description: Specifies the path of the file system. type: - string - 'null' x-go-name: Path x-go-package: cohesity/iris/server/data/public NimbleProtectionSource: description: Specifies a Protection Source in a Nimble environment. type: object title: Nimble Protection Source. properties: name: description: Specifies a unique name of the Protection Source type: - string - 'null' x-go-name: Name storageArray: description: 'Specifies a SAN Storage Array information. This is set only when the type is kStorageArray.' $ref: '#/components/schemas/SanStorageArray' type: description: 'Specifies the type of managed Object in a SAN/Nimble Protection Source like a kStorageArray or kVolume. Examples of SAN Objects include ''kStorageArray'' and ''kVolume''. ''kStorageArray'' indicates that entire SAN storage array is being protected. ''kVolume'' indicates that volume within the array is being protected.' type: - string - 'null' enum: - kStorageArray - kVolume x-go-name: Type volume: description: 'Specifies a SAN Volume information within a storage array. This is set only when the type is kVolume.' $ref: '#/components/schemas/SanVolume' x-go-package: cohesity/iris/server/data/public Office365Credentials: description: Specifies the credentials to authenticate with Office365 account. type: object title: Office365 Credentials. properties: clientId: description: 'Specifies the application ID that the registration portal (apps.dev.microsoft.com) assigned.' type: - string - 'null' x-go-name: ClientId clientSecret: description: 'Specifies the application secret that was created in app registration portal.' type: - string - 'null' x-go-name: ClientSecret grantType: description: 'Specifies the application grant type. eg: For client credentials flow, set this to "client_credentials"; For refreshing access-token, set this to "refresh_token".' type: - string - 'null' x-go-name: GrantType scope: description: 'Specifies a space separated list of scopes/permissions for the user. eg: Incase of MS Graph APIs for Office365, scope is set to default: https://graph.microsoft.com/.default' type: - string - 'null' x-go-name: Scope useOAuthForExchangeOnline: description: 'This field is deprecated from here and placed in RegisteredSourceInfo and ProtectionSourceParameters. deprecated: true' type: - boolean - 'null' x-go-name: UseOAuthForExchangeOnline x-go-package: cohesity/iris/server/data/public ProtectionSourceTreeInfo: description: 'Specifies the registration and protection information of a registered Protection Source Tree on the Cohesity Cluster. Many different Protection Source trees are supported such as ''kVMware'', ''kAcropolis'', ''kPhysical'' etc.,' type: object title: Registration and Protection Information. properties: applications: description: 'Array of applications hierarchy registered on this node. Specifies the application type and the list of instances of the application objects. For example for SQL Server, this list provides the SQL Server instances running on a VM or a Physical Server.' type: - array - 'null' items: $ref: '#/components/schemas/ApplicationInfo' x-go-name: Applications entityPermissionInfo: description: 'Specifies permission information for the protection source for the root node of protection source tree.' $ref: '#/components/schemas/EntityPermissionInformation' logicalSizeBytes: description: Specifies the logical size of the Protection Source in bytes. type: - integer - 'null' format: int64 x-go-name: LogicalSizeBytes registrationInfo: description: 'Specifies registration information for a root node in a Protection Sources tree. A root node represents a registered Source on the Cohesity Cluster, such as a vCenter Server.' allOf: - $ref: '#/components/schemas/RegisteredSourceInfo' rootNode: description: 'Specifies the Protection Source for the root node of the Protection Source tree.' allOf: - $ref: '#/components/schemas/ProtectionSource' stats: description: Specifies the stats of protection for a Protection Source Tree. allOf: - $ref: '#/components/schemas/ProtectionSummary' statsByEnv: description: 'Specifies the breakdown of the stats of protection by environment. overrideDescription: true' type: - array - 'null' items: $ref: '#/components/schemas/ProtectionSummaryByEnv' x-go-name: StatsByEnv x-go-package: cohesity/iris/server/data/public CopySnapshotTaskStatus: description: 'Specifies the status of the copy task that copies the snapshot of a Protection Source object to a target.' type: object title: Copy Snapshot Task Status. properties: error: description: 'Specifies if an error occurred (if any) while running this task. This field is populated when the status is equal to ''kFailure''.' type: - string - 'null' x-go-name: Error source: description: 'Specifies the source object whose snapshot is replicated. This is specified for replication targets.' $ref: '#/components/schemas/ProtectionSource' stats: description: Specifies the stats of the replication or the archival task. $ref: '#/components/schemas/CopyRunStats' status: description: 'Specifies the status of the source object being protected. ''kAccepted'' indicates the task is queued to run but not yet running. ''kRunning'' indicates the task is running. ''kCanceling'' indicates a request to cancel the task has occurred but the task is not yet canceled. ''kCanceled'' indicates the task has been canceled. ''kSuccess'' indicates the task was successful. ''kFailure'' indicates the task failed. ''kWarning'' indicates the task has finished with warning. ''kOnHold'' indicates the task is kept onHold. ''kMissed'' indicates the task is missed.' type: - string - 'null' enum: - kAccepted - kRunning - kCanceling - kCanceled - kSuccess - kFailure - kWarning - kOnHold - kMissed x-go-name: Status taskEndTimeUsecs: description: 'Specifies the end time of the copy task. The end time is specified as a Unix epoch Timestamp (in microseconds).' type: - integer - 'null' format: int64 x-go-name: TaskEndTimeUsecs taskStartTimeUsecs: description: 'Specifies the start time of the copy task. The start time is specified as a Unix epoch Timestamp (in microseconds). Copy run task is started after completing backup tasks. It may spawn sub-tasks to copy or replicate individual snapshots.' type: - integer - 'null' format: int64 x-go-name: TaskStartTimeUsecs x-go-package: cohesity/iris/server/data/public HdfsProtectionSource: description: Specifies an Object representing Hdfs. type: object title: Hdfs Protection Source. properties: name: description: Specifies the instance name of the Hdfs entity. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of the managed Object in Hdfs Protection Source. Specifies the type of an Hdfs source entity. ''kCluster'' indicates a Hdfs cluster distributed over several physical nodes.' type: - string - 'null' enum: - kCluster x-go-name: Type uuid: description: Specifies the UUID for the Hdfs entity. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public FlashBladeNetworkInterface: description: Specifies network interface detail of a Flash Blade Storage Array. type: object title: Flash Blade Network Interface. properties: ipAddress: description: Specifies the IP address of the Pure Storage FlashBlade Array. type: - string - 'null' x-go-name: IpAddress name: description: Specifies the name of the network interface. type: - string - 'null' x-go-name: Name vlan: description: Specifies the id of the VLAN network of the Pure Storage FlashBlade Array. type: - integer - 'null' format: int32 x-go-name: Vlan x-go-package: cohesity/iris/server/data/public CloudParameters: description: 'Specifies Cloud parameters that are applicable to all Protection Sources in a Protection Job in certain scenarios.' type: object title: Cloud Parameters. properties: failoverToCloud: description: 'Specifies whether the Protection Sources in this Protection Job will be failed over to Cloud. This flag is applicable to backup on-prem Sources.' type: - boolean - 'null' x-go-name: FailoverToCloud x-go-package: cohesity/iris/server/data/public ProtectionPolicy: type: object properties: blackoutPeriods: description: 'Array of Blackout Periods. If specified, this field defines black periods when new Job Runs are not started. If a Job Run has been scheduled but not yet executed and the blackout period starts, the behavior depends on the policy field AbortInBlackoutPeriod.' type: - array - 'null' items: $ref: '#/components/schemas/BlackoutPeriod' x-go-name: BlackoutPeriods cdpSchedulingPolicy: description: 'Specifies the CDP backup schedule of a Protection Job and how long log files captured by this schedule are retained on the Cohesity Cluster.' title: CDP Job Policy. $ref: '#/components/schemas/SchedulingPolicy' cloudDeployPolicies: description: 'Array of Cloud Deploy Policies. Specifies settings for copying Snapshots to Cloud. CloudDeploy target where backup snapshots may be converted and stored. It also defines the retention of copied Snapshots on the Cloud.' type: - array - 'null' items: $ref: '#/components/schemas/SnapshotCloudCopyPolicy' x-go-name: SnapshotCloudCopyPolicies datalockConfig: description: 'Specifies WORM retention type for the incremental/full snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept for the last N days as specified in the duration of the datalock. During that time, the snapshots cannot be deleted.' $ref: '#/components/schemas/DataLockConfig' datalockConfigLog: description: 'Specifies WORM retention type for the log snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept for the last N days as specified in the duration of the datalock. During that time, the snapshots cannot be deleted.' $ref: '#/components/schemas/DataLockConfig' datalockConfigSystem: description: 'Specifies WORM retention type for the BMR snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept for the last N days as specified in the duration of the datalock. During that time, the snapshots cannot be deleted.' $ref: '#/components/schemas/DataLockConfig' daysToKeep: description: Specifies how many days to retain Snapshots on the Cohesity Cluster. type: - integer - 'null' format: int64 x-go-name: DaysToKeep daysToKeepLog: description: Specifies the number of days to retain log run if Log Schedule exists. type: - integer - 'null' format: int64 x-go-name: DaysToKeepLog daysToKeepSystem: description: 'Specifies the number of days to retain system backups made for bare metal recovery. This field is applicable if systemSchedulingPolicy is specified.' type: - integer - 'null' format: int64 x-go-name: DaysToKeepSystem description: description: Description of the Protection Policy. type: - string - 'null' x-go-name: Description extendedRetentionPolicies: description: 'Specifies additional retention policies that should be applied to the backup snapshots. A backup snapshot will be retained up to a time that is the maximum of all retention policies that are applicable to it.' type: - array - 'null' items: $ref: '#/components/schemas/ExtendedRetentionPolicy' x-go-name: ExtendedRetentionPolicies fullSchedulingPolicy: description: 'Specifies the Full (no CBT) backup schedule of a Protection Job and how long Snapshots captured by this schedule are retained on the Cohesity Cluster.' title: Full (no CBT) Job Policy. allOf: - $ref: '#/components/schemas/SchedulingPolicy' id: description: Specifies a unique Policy id assigned by the Cohesity Cluster. type: - string - 'null' x-go-name: Id incrementalSchedulingPolicy: description: 'Specifies the CBT-based backup schedule of a Protection Job and how long Snapshots captured by this schedule are retained on the Cohesity Cluster.' title: CBT-based Job Policy. allOf: - $ref: '#/components/schemas/SchedulingPolicy' isUsable: description: Specifies if the policy can be used to create a job. type: - boolean - 'null' x-go-name: IsUsable lastModifiedTimeMsecs: description: 'Specifies the epoch time (in milliseconds) when the Protection Policy was last modified.' type: - integer - 'null' format: int64 x-go-name: LastModifiedTimeMsecs logSchedulingPolicy: description: 'Specifies the Log backup schedule of a Protection Job and how long log files captured by this schedule are retained on the Cohesity Cluster.' title: Log Job Policy. $ref: '#/components/schemas/SchedulingPolicy' name: description: Specifies the name of the Protection Policy. type: - string - 'null' x-go-name: Name numLinkedPolicies: description: Species the number of policies linked to a global policy. type: - integer - 'null' format: int64 x-go-name: NumLinkedPolicies parentPolicyId: description: 'Specifies the parent global policy Id. This must be specified when creating a policy from global policy template.' type: - string - 'null' x-go-name: ParentPolicyId retries: description: 'Specifies the number of times to retry capturing Snapshots before the Job Run fails.' type: - integer - 'null' format: int32 x-go-name: Retries retryIntervalMins: description: Specifies the number of minutes before retrying a failed Protection Job. type: - integer - 'null' format: int32 x-go-name: RetryIntervalMins rpoPolicySettings: description: Specifies the RPO Policy related settings. $ref: '#/components/schemas/RpoPolicySettings' skipIntervalMins: description: 'Specifies the period of time before skipping the execution of new Job Runs if an existing queued Job Run of the same Protection Job has not started. For example if this field is set to 30 minutes and a Job Run is scheduled to start at 5:00 AM every day but does not start due to conflicts (such as too many Jobs are running). If the new Job Run does not start by 5:30AM, the Cohesity Cluster will skip the new Job Run. If the original Job Run completes before 5:30AM the next day, a new Job Run is created and starts executing. This field is optional.' type: - integer - 'null' format: int32 x-go-name: SkipIntervalMins snapshotArchivalCopyPolicies: description: 'Array of External Targets. Specifies settings for copying Snapshots to Archival External Targets (such as AWS or Tape). It also defines the retention of copied Snapshots on an External Targets such as AWS and Tape.' type: - array - 'null' items: $ref: '#/components/schemas/SnapshotArchivalCopyPolicy' x-go-name: SnapshotArchivalCopyPolicies snapshotReplicationCopyPolicies: description: 'Array of Remote Clusters. Specifies settings for copying Snapshots to Remote Clusters. It also defines the retention of copied Snapshots on a Remote Cluster.' type: - array - 'null' items: $ref: '#/components/schemas/SnapshotReplicationCopyPolicy' x-go-name: SnapshotReplicationCopyPolicies systemSchedulingPolicy: description: 'Specifies the system backup schedule for agents running on servers to run low frequency backup jobs. Images created as part of the backup can be used to perform a "bare metal" recovery.' title: Agent driven System Job Policy. $ref: '#/components/schemas/SchedulingPolicy' tenantIds: description: 'Specifies which organizations have been assigned this policy. This value is only populated for the cluster admin for now.' type: - array - 'null' items: type: string x-go-name: TenantIds type: description: 'Specifies the type of the protection policy. ''kRegular'' means a regular Protection Policy. ''kRPO'' means an RPO Protection Policy.' type: - string - 'null' enum: - kRegular - kRPO x-go-name: Type wormRetentionType: description: 'Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Jobs using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. This field is deprecated. Use DataLockConfig for incremental runs, DataLockConfigLog for log runs, DataLockConfigSystem for BMR runs, and DataLockConfig in extended retention and for copy targets config. deprecated: true ''kNone'' implies there is no WORM retention set. ''kCompliance'' implies WORM retention is set for compliance reason. ''kAdministrative'' implies WORM retention is set for administrative purposes.' type: - string - 'null' enum: - kNone - kCompliance - kAdministrative x-go-name: WormRetentionType x-go-package: cohesity/iris/server/data/public ExchangeProtectionSource: description: 'Specifies an object representing an Exchange entity. DAG - Database availability group' type: object title: Exchange Protection Source. properties: DagInfo: description: 'Specifies the Exchange DAG information if ExchangeProtectionSourceType is ''kExchangeDAG''.' $ref: '#/components/schemas/DagInfo' applicationServerInfo: description: 'Specifies the Exchange Application server information if ExchangeProtectionSourceType is ''kExchangeNode''.' $ref: '#/components/schemas/ApplicationServerInfo' dagDatabaseCopyInfo: description: 'Specifies the Exchange DAG Database copy information if ExchangeProtectionSourceType is ''kExchangeDAGDatabaseCopy''.' $ref: '#/components/schemas/ExchangeDatabaseCopyInfo' dagDatabaseInfo: description: 'Specifies the Exchange DAG Database information if ExchangeProtectionSourceType is ''kExchangeDAGDatabase''' $ref: '#/components/schemas/ExchangeDAGDatabase' name: type: - string - 'null' x-go-name: Name ownerId: description: Specifies the entity id of the owner of the Exchange Protection Source. type: - integer - 'null' format: int64 x-go-name: OwnerId standaloneDatabaseCopyInfo: description: 'Specifies the Exchange Standalone Database information if ExchangeProtectionSourceType is ''kExchangeStandaloneDatabase''.' $ref: '#/components/schemas/ExchangeDatabaseInfo' type: description: Specifies the type of the Exchange Protection Source. type: - integer - 'null' format: int32 x-go-name: Type uuid: description: Specifies the UUID for the Exchange entity. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public EmailDeliveryTarget: description: 'EmailDeliveryTarget Specifies the email address and the locale setting for it.' type: object properties: emailAddress: type: - string - 'null' x-go-name: EmailAddress locale: description: 'Specifies the language in which the emails sent to the above defined mail address should be in.' type: - string - 'null' x-go-name: Locale recipientType: description: Specifies the recipient type on how the emails are to received. type: - integer - 'null' format: int32 x-go-name: RecipientType x-go-package: cohesity/iris/server/data/public OracleDatabaseNode: description: 'Oracle Database Node. Specifies database node required for the backup and restore.' type: object title: 'Data related to a ''kOracle'' database node. Refer: magnetoProto.OracleDBChannelInfo_HostInfo' properties: channelCount: description: 'Specifies the number of channels user wants for the backup/recovery of this node.' type: - integer - 'null' format: int32 x-go-name: ChannelCount node: description: Specifies the ip of the database node. type: - string - 'null' x-go-name: Node port: description: Specifies the port on which user wants to run the backup/recovery. type: - integer - 'null' format: int64 x-go-name: Port sbtHostParams: description: Specifies the necessary parameters for SBT. $ref: '#/components/schemas/OracleSbtHostParams' x-go-package: cohesity/iris/server/data/public OracleProtectionSource: description: Specifies an Object representing one Oracle database. type: object title: Oracle Protection Source. properties: archiveLogEnabled: description: 'Specifies whether the database is running in ARCHIVELOG mode. It enables the redo of log files into archived redo log files.' type: - boolean - 'null' x-go-name: ArchiveLogEnabled bctEnabled: description: 'Specifies whether the Block Change Tracking is enabled. BCT improves the performance of incremental backups by recording changed blocks into the block change tracking file. RMAN then uses this file to identify changed blocks to be backed up.' type: - boolean - 'null' x-go-name: BCTEnabled containerDatabaseInfo: description: 'Specifies the Container Database Information including the Pluggable databases within the container.' $ref: '#/components/schemas/OracleContainerDatabaseInfo' dataGuardInfo: description: 'Specifies the Data Gurad configuration information for the current DB entity.' $ref: '#/components/schemas/OracleDataGuardInfo' databaseUniqueName: description: Specifies the unique name of the Oracle entity. type: - string - 'null' x-go-name: DatabaseUniqueName dbType: description: 'Specifies the type of the database in Oracle Protection Source. ''kRACDatabase'' indicates the database is a RAC DB. ''kSingleInstance'' indicates that the database is single instance.' type: - string - 'null' enum: - kSingleInstance - kRACDatabase x-go-name: DbType domain: description: Specifies the Oracle DB Domain. type: - string - 'null' x-go-name: Domain fraSize: description: Specifies Flash/Fast Recovery area size for the current DB entity. type: - integer - 'null' format: int64 x-go-name: FraSize hosts: description: Specifies the list of hosts for the current DB entity. type: - array - 'null' items: $ref: '#/components/schemas/OracleHost' x-go-name: Hosts name: description: Specifies the instance name of the Oracle entity. type: - string - 'null' x-go-name: Name ownerId: description: 'Specifies the entity id of the owner entity (such as a VM). This is only set if type is kDatabase.' type: - integer - 'null' format: int64 x-go-name: OwnerId sgaTargetSize: description: 'Specifies System Global Area size for the current DB entity. A system global area (SGA) is a group of shared memory structures that contain data and control information for one Oracle database.' type: - string - 'null' x-go-name: SgaTargetSize sharedPoolSize: description: Specifies Shared Pool Size for the current DB entity. type: - string - 'null' x-go-name: SharedPoolSize size: description: Specifies database size. type: - integer - 'null' format: int64 x-go-name: Size tdeEncryptedTsCount: description: Specifies the number of TDE encrypted tablespaces found in the database. type: - integer - 'null' format: int64 x-go-name: TdeEncryptedTsCount tempFilesCount: description: Specifies number of temporary files for the current DB entity. type: - integer - 'null' format: int64 x-go-name: TempFilesCount type: description: 'Specifies the type of the managed Object in Oracle Protection Source. ''kRACRootContainer'' indicates the entity is a root container to an Oracle Real Application clusters(Oracle RAC). ''kRootContainer'' indicates the entity is a root container to an Oracle standalone server. ''kHost'' indicates the entity is an Oracle host. ''kDatabase'' indicates the entity is an Oracle Database. ''kTableSpace'' indicates the entity is an Oracle table space. ''kTable'' indicates the entity is an Oracle table.' type: - string - 'null' enum: - kRACRootContainer - kRootContainer - kHost - kDatabase - kTableSpace - kTable x-go-name: Type uuid: description: Specifies the UUID for the Oracle entity. type: - string - 'null' x-go-name: Uuid version: description: Specifies the Oracle database instance version. type: - string - 'null' x-go-name: Version x-go-package: cohesity/iris/server/data/public HiveProtectionSource: description: Specifies an Object representing Hive. type: object title: Hive Protection Source. properties: name: description: Specifies the instance name of the Hive entity. type: - string - 'null' x-go-name: Name tableInfo: description: 'Information of a Hive Table, only valid for an entity of type kTable.' $ref: '#/components/schemas/HiveTable' type: description: 'Specifies the type of the managed Object in Hive Protection Source. Specifies the type of an Hive source entity. ''kCluster'' indicates a Hive cluster distributed over several physical nodes. ''kDatabase'' indicates a Database in the Hive environment. ''kTable'' indicates a Table in the Hive environment.' type: - string - 'null' enum: - kCluster - kDatabase - kTable x-go-name: Type uuid: description: Specifies the UUID for the Hive entity. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public OneDriveEnvJobParameters: description: 'Specifies OneDrive job parameters applicable for all Office365 Environment type Protection Sources in a Protection Job.' type: object title: OneDrive Environment Job Parameters. properties: filePathFilter: description: 'The filtering policy describes which paths within the onedrive should be excluded within the backup. If this is not specified, then the entire onedrive will be backed up.' $ref: '#/components/schemas/FilePathFilter' shouldBackupOnedrive: description: 'Specifies whether OneDrive(s) of each Office365 Users/Groups within the job, should be backed up or not.' type: - boolean - 'null' x-go-name: ShouldBackupOnedrive x-go-package: cohesity/iris/server/data/public CloudDeployTargetDetails: description: 'Message that specifies the details about CloudDeploy target where backup snapshots may be converted and stored.' type: object properties: awsParams: description: Specifies various resources when converting and deploying a VM to AWS. title: 'Contains information needed to identify various resources when deploying VMs to Cloud.' $ref: '#/components/schemas/AwsParams' azureParams: description: Specifies various resources when converting and deploying a VM to Azure. $ref: '#/components/schemas/AzureParams' gcpParams: description: Specifies various resources when converting and deploying a VM to Gcp. $ref: '#/components/schemas/GcpParams' id: description: 'Entity corresponding to the cloud deploy target. Specifies the id field inside the EntityProto.' type: - integer - 'null' format: int64 x-go-name: Id name: description: 'Specifies the inner object''s name or a human-readable string made off the salient attributes. This is only plumbed when Entity objects are exposed to Iris BE or to Yoda.' type: - string - 'null' x-go-name: DisplayName type: description: 'Specifies the type of the CloudDeploy target. ''kAzure'' indicates that Azure as a cloud deploy target type. ''kAWS'' indicates that AWS as a cloud deploy target type. ''kGCP'' indicates that GCP as a cloud deploy target type.' type: - string - 'null' enum: - kAzure - kAWS - kGCP x-go-name: Type x-go-package: cohesity/iris/server/data/public OracleHost: description: Specifies information about an Oracle Host. type: object title: Oracle Host. properties: cpuCount: description: Specifies the count of CPU available on the host. type: - integer - 'null' format: int32 x-go-name: CpuCount ipAddresses: description: Specifies the IP address of the host. type: - array - 'null' items: type: string x-go-name: IpAddresses ports: description: Specifies ports available for this host. type: - array - 'null' items: type: integer format: int64 x-go-name: Ports sessions: description: Specifies multiple session configurations available for this host. type: - array - 'null' items: $ref: '#/components/schemas/OracleSession' x-go-name: Sessions x-go-package: cohesity/iris/server/data/public CassandraProtectionSource: description: Specifies an Object representing Cassandra. type: object title: Cassandra Protection Source. properties: clusterInfo: description: 'Information of a Cassandra cluster, only valid for an entity of type kCluster.' $ref: '#/components/schemas/CassandraCluster' keyspaceInfo: description: 'Information of a cassandra keyspapce, only valid for an entity of type kKeyspace.' $ref: '#/components/schemas/CassandraKeyspace' name: description: Specifies the instance name of the Cassandra entity. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of the managed Object in Cassandra Protection Source. Replication strategy options for a keyspace. ''kCluster'' indicates a Cassandra cluster distributed over several physical nodes. ''kKeyspace'' indicates a Keyspace enclosing one or more tables. ''kTable'' indicates a Table in the Cassandra environment.' type: - string - 'null' enum: - kCluster - kKeyspace - kTable x-go-name: Type uuid: description: 'Specifies the UUID for the Cassandra entity. Note : For each entity an ID unique within top level entity should be assigned by imanis backend. Example, UUID for a table can be the string .' type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public ExtendedRetentionPolicy: description: Specifies additional retention policies to apply to backup snapshots. type: object title: Extended Retention Policy. properties: Id: description: 'Specified the Id for a snapshot copy policy. This is generated when the policy is created.' type: - string - 'null' backupRunType: description: 'The backup run type to which this extended retention applies to. If this is not set, the extended retention will be applicable to all non-log backup types. Currently, the only value that can be set here is kFull. ''kRegular'' indicates a incremental (CBT) backup. Incremental backups utilizing CBT (if supported) are captured of the target protection objects. The first run of a kRegular schedule captures all the blocks. ''kFull'' indicates a full (no CBT) backup. A complete backup (all blocks) of the target protection objects are always captured and Change Block Tracking (CBT) is not utilized. ''kLog'' indicates a Database Log backup. Capture the database transaction logs to allow rolling back to a specific point in time. ''kSystem'' indicates a system backup. System backups are used to do bare metal recovery of the system to a specific point in time.' type: - string - 'null' enum: - kRegular - kFull - kLog - kSystem x-go-name: BackupRunType datalockConfig: description: Specifies WORM retention type for snapshots under extended retention. $ref: '#/components/schemas/DataLockConfig' daysToKeep: description: Specifies the number of days to retain copied Snapshots on the target. type: - integer - 'null' format: int64 x-go-name: DaysToKeep multiplier: description: 'Specifies a factor to multiply the periodicity by, to determine the copy schedule. For example if set to 2 and the periodicity is hourly, then Snapshots from the first eligible Job Run for every 2 hour period is copied.' type: - integer - 'null' format: int32 x-go-name: Multiplier periodicity: description: 'Specifies the frequency that Snapshots should be copied to the specified target. Used in combination with multiplier. ''kEvery'' means that the Snapshot copy occurs after the number of Job Runs equals the number specified in the multiplier. ''kHour'' means that the Snapshot copy occurs hourly at the frequency set in the multiplier, for example if multiplier is 2, the copy occurs every 2 hours. ''kDay'' means that the Snapshot copy occurs daily at the frequency set in the multiplier. ''kWeek'' means that the Snapshot copy occurs weekly at the frequency set in the multiplier. ''kMonth'' means that the Snapshot copy occurs monthly at the frequency set in the multiplier. ''kYear'' means that the Snapshot copy occurs yearly at the frequency set in the multiplier.' type: - string - 'null' enum: - kEvery - kHour - kDay - kWeek - kMonth - kYear x-go-name: Periodicity x-go-package: cohesity/iris/server/data/public OutlookEnvJobParameters: description: 'Specifies Outlook job parameters applicable for all Office365 Environment type Protection Sources in a Protection Job.' type: object title: Outlook Environment Job Parameters. properties: filePathFilter: description: 'The filtering policy describes which paths within the mailbox should be excluded within the backup. If this is not specified, then the entire mailbox will be backed up.' $ref: '#/components/schemas/FilePathFilter' shouldBackupMailbox: description: 'Specifies whether mailbox of each Office365 Users/Groups within the job, should be backed up or not.' type: - boolean - 'null' x-go-name: ShouldBackupMailbox x-go-package: cohesity/iris/server/data/public ApplicationServerInfo: description: Specifies the Information about the Exchange Server Node. type: object title: Application Server Info properties: databaseCopyInfoList: description: 'Specifies the list of all the copies of the Exchange databases(that are part of DAG) that are present on this Exchange Node.' type: - array - 'null' items: $ref: '#/components/schemas/ExchangeDatabaseCopyInfo' x-go-name: DatabaseCopyInfoList databaseInfoList: description: 'Specifies the list of all the databases available on the standalone Exchange server node. This is populated for the Standlone Exchange Servers.' type: - array - 'null' items: $ref: '#/components/schemas/ExchangeDatabaseInfo' x-go-name: DatabaseInfoList fqdn: description: Specifies the fully qualified domain name of the Exchange Server. type: - string - 'null' x-go-name: Fqdn guid: description: Specifies the Guid of the Exchange Application Server. type: - string - 'null' x-go-name: Guid name: description: Specifies the display name of the Exchange Application Server. type: - string - 'null' x-go-name: Name totalSizeBytes: description: 'Specifies the total size of all Exchange database copies in all the Exchange Application Servers that are part of the DAG.' type: - integer - 'null' format: int64 x-go-name: TotalSizeBytes x-go-package: cohesity/iris/server/data/public IsilonAccessZone: description: Specifies information about access zone in an Isilon Cluster. type: object title: Isilon Access Zone. properties: id: description: Specifies the id of the access zone. type: - integer - 'null' format: int64 x-go-name: Id name: description: Specifies the name of the access zone. type: - string - 'null' x-go-name: Name path: description: 'Specifies the path of the access zone in ifs. This should include the leading "/ifs/".' type: - string - 'null' x-go-name: Path x-go-package: cohesity/iris/server/data/public ExchangeDAGDatabase: description: 'Specifies the information about all the copies of the database that is part of DAG.' type: object title: Exchange DAG database Information properties: databaseCopyInfoList: description: 'Specifies about all the copies of this DAG database. This include active and passive copy of the database.' type: - array - 'null' items: $ref: '#/components/schemas/ExchangeDatabaseCopyInfo' x-go-name: DatabaseCopyInfoList guid: description: Specifies the guid of the database. type: - string - 'null' x-go-name: Guid name: description: Specifies the name of the database. type: - string - 'null' x-go-name: Name x-go-package: cohesity/iris/server/data/public UnRegisterApplicationServersParameters: description: 'Specifies the parameters required to unregister Application Servers running in a Protection Source.' type: object title: UnRegister Application Servers Parameters. properties: applications: description: 'Specifies the types of applications such as ''kSQL'', ''kExchange'', ''kAD'' running on the Protection Source. overrideDescription: true Supported environment types such as ''kView'', ''kSQL'', ''kVMware'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter. ''kVMware'' indicates the VMware Protection Source environment. ''kHyperV'' indicates the HyperV Protection Source environment. ''kSQL'' indicates the SQL Protection Source environment. ''kView'' indicates the View Protection Source environment. ''kPuppeteer'' indicates the Cohesity''s Remote Adapter. ''kPhysical'' indicates the physical Protection Source environment. ''kPure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''kAzure'' indicates the Microsoft''s Azure Protection Source environment. ''kNetapp'' indicates the Netapp Protection Source environment. ''kAgent'' indicates the Agent Protection Source environment. ''kGenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''kAcropolis'' indicates the Acropolis Protection Source environment. ''kPhsicalFiles'' indicates the Physical Files Protection Source environment. ''kIsilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''kGPFS'' indicates IBM''s GPFS Protection Source environment. ''kKVM'' indicates the KVM Protection Source environment. ''kAWS'' indicates the AWS Protection Source environment. ''kExchange'' indicates the Exchange Protection Source environment. ''kHyperVVSS'' indicates the HyperV VSS Protection Source environment. ''kOracle'' indicates the Oracle Protection Source environment. ''kGCP'' indicates the Google Cloud Platform Protection Source environment. ''kFlashBlade'' indicates the Flash Blade Protection Source environment. ''kAWSNative'' indicates the AWS Native Protection Source environment. ''kO365'' indicates the Office 365 Protection Source environment. ''kO365Outlook'' indicates Office 365 outlook Protection Source environment. ''kHyperFlex'' indicates the Hyper Flex Protection Source environment. ''kGCPNative'' indicates the GCP Native Protection Source environment. ''kAzureNative'' indicates the Azure Native Protection Source environment. ''kKubernetes'' indicates a Kubernetes Protection Source environment. ''kElastifile'' indicates Elastifile Protection Source environment. ''kAD'' indicates Active Directory Protection Source environment. ''kRDSSnapshotManager'' indicates AWS RDS Protection Source environment. ''kCassandra'' indicates Cassandra Protection Source environment. ''kMongoDB'' indicates MongoDB Protection Source environment. ''kCouchbase'' indicates Couchbase Protection Source environment. ''kHdfs'' indicates Hdfs Protection Source environment. ''kHive'' indicates Hive Protection Source environment. ''kHBase'' indicates HBase Protection Source environment.' type: - array - 'null' items: type: string enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kNimble - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kAzureNative - kKubernetes - kElastifile - kAD - kRDSSnapshotManager - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase x-go-name: Applications x-go-package: cohesity/iris/server/data/public ReplicationTargetSettings: description: 'Specifies settings about the Remote Cohesity Cluster where Snapshots are copied to.' type: object title: Replication Target. properties: clusterId: description: Specifies the id of the Remote Cluster. type: - integer - 'null' format: int64 x-go-name: ClusterId clusterName: description: Specifies the name of the Remote Cluster. type: - string - 'null' x-go-name: ClusterName x-go-package: cohesity/iris/server/data/public IsilonCluster: description: Specifies information about an Isilon Cluster. type: object title: Isilon Cluster. properties: apiVersionStr: description: Specifies the API version of an Isilon Cluster as string. type: - string - 'null' x-go-name: ApiVersionStr description: description: Specifies the description of an Isilon Cluster. type: - string - 'null' x-go-name: Description guid: description: Specifies a globally unique id of an Isilon Cluster. type: - string - 'null' x-go-name: Guid version: description: Specifies the version of an Isilon Cluster. type: - string - 'null' x-go-name: Version x-go-package: cohesity/iris/server/data/public CassandraSecurityInfo: description: Specifies an Object containing information on Cassandra security. type: object title: CassandraSecurityInfo Cassandra security info. properties: cassandraAuthRequired: description: Is Cassandra authentication required ? type: - boolean - 'null' x-go-name: CassandraAuthRequired cassandraAuthType: description: 'Cassandra Authentication type. Enum: [PASSWORD KERBEROS LDAP] Specifies the Cassandra auth type. ''PASSWORD'' ''KERBEROS'' ''LDAP''' type: - string - 'null' enum: - PASSWORD - KERBEROS - LDAP x-go-name: CassandraAuthType cassandraAuthorizer: description: Cassandra Authenticator/Authorizer. type: - string - 'null' x-go-name: CassandraAuthorizer clientEncryption: description: Is Client Encryption enabled for this cluster ? type: - boolean - 'null' x-go-name: ClientEncryption dseAuthorization: description: Is DSE Authorization enabled for this cluster ? type: - boolean - 'null' x-go-name: DseAuthorization serverEncryptionReqClientAuth: description: Is 'Server encryption request client authentication' enabled for this cluster ? type: - boolean - 'null' x-go-name: ServerEncryptionReqClientAuth serverInternodeEncryptionType: description: '''Server internal node Encryption'' type for this cluster.' type: - string - 'null' x-go-name: ServerInternodeEncryptionType x-go-package: cohesity/iris/server/data/public BlackoutPeriod: description: 'Specifies a time range in a single day when new Job Runs of Protection Jobs cannot be started. For example, a Protection Job with a daily schedule could define a blackout period for Sunday.' type: object title: Blackout Period. properties: Id: description: 'Specified the Id for a snapshot copy policy. This is generated when the policy is created.' type: - string - 'null' day: description: 'Blackout Day. Specifies a day in the week when no new Job Runs should be started such as ''kSunday''. If not set, the time range applies to all days. Specifies a day in a week such as ''kSunday'', ''kMonday'', etc.' type: - string - 'null' enum: - kSunday - kMonday - kTuesday - kWednesday - kThursday - kFriday - kSaturday x-go-name: Day endTime: description: Specifies the end time of the blackout time range. title: Blackout End Time. allOf: - $ref: '#/components/schemas/TimeOfDay' startTime: description: Specifies the start time of the blackout time range. title: Blackout Start Time. allOf: - $ref: '#/components/schemas/TimeOfDay' x-go-package: cohesity/iris/server/data/public AgentInformation: description: 'Specifies information about the Agent software running on the server or the Virtual Machine.' type: object title: Agent Information. properties: cbmrVersion: description: Specifies the version if Cristie BMR product is installed on the host. type: - string - 'null' x-go-name: CbmrVersion hostType: description: 'Specifies the host type where the agent is running. This is only set for persistent agents. ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: HostType id: description: Specifies the agent's id. type: - integer - 'null' format: int64 x-go-name: Id name: description: Specifies the agent's name. type: - string - 'null' x-go-name: Name oracleMultiNodeChannelSupported: description: Specifies whether oracle multi node multi channel is supported or not. type: - boolean - 'null' x-go-name: OracleMultiNodeChannelSupported registrationInfo: description: Specifies registration information for an Agent. $ref: '#/components/schemas/RegisteredSourceInfo' sourceSideDedupEnabled: description: Specifies whether source side dedup is enabled or not. type: - boolean - 'null' x-go-name: SourceSideDedupEnabled status: description: 'Specifies the agent status. Specifies the status of the agent running on a physical source. ''kUnknown'' indicates the Agent is not known. No attempt to connect to the Agent has occurred. ''kUnreachable'' indicates the Agent is not reachable. ''kHealthy'' indicates the Agent is healthy. ''kDegraded'' indicates the Agent is running but in a degraded state.' type: - string - 'null' enum: - kUnknown - kUnreachable - kHealthy - kDegraded x-go-name: Status statusMessage: description: Specifies additional details about the agent status. type: - string - 'null' x-go-name: StatusMessage upgradability: description: 'Specifies the upgradability of the agent running on the physical server. Specifies the upgradability of the agent running on the physical server. ''kUpgradable'' indicates the Agent can be upgraded to the agent software version on the cluster. ''kCurrent'' indicates the Agent is running the latest version. ''kUnknown'' indicates the Agent''s version is not known. ''kNonUpgradableInvalidVersion'' indicates the Agent''s version is invalid. ''kNonUpgradableAgentIsNewer'' indicates the Agent''s version is newer than the agent software version the cluster. ''kNonUpgradableAgentIsOld'' indicates the Agent''s version is too old that does not support upgrades.' type: - string - 'null' enum: - kUpgradable - kCurrent - kUnknown - kNonUpgradableInvalidVersion - kNonUpgradableAgentIsNewer - kNonUpgradableAgentIsOld x-go-name: Upgradability upgradeStatus: description: 'Specifies the status of the upgrade of the agent on a physical server. Specifies the status of the upgrade of the agent on a physical server. ''kIdle'' indicates there is no agent upgrade in progress. ''kAccepted'' indicates the Agent upgrade is accepted. ''kStarted'' indicates the Agent upgrade is in progress. ''kFinished'' indicates the Agent upgrade is completed.' type: - string - 'null' enum: - kIdle - kAccepted - kStarted - kFinished x-go-name: UpgradeStatus upgradeStatusMessage: description: 'Specifies detailed message about the agent upgrade failure. This field is not set for successful upgrade.' type: - string - 'null' x-go-name: UpgradeStatusMessage version: description: Specifies the version of the Agent software. type: - string - 'null' x-go-name: Version x-go-package: cohesity/iris/server/data/public ArchivalExternalTarget: description: Specifies settings about the Archival External Target (such as Tape or AWS). type: object title: Archival Target. properties: vaultId: description: Specifies the id of Archival Vault assigned by the Cohesity Cluster. type: - integer - 'null' format: int64 x-go-name: VaultId vaultName: description: Name of the Archival Vault. type: - string - 'null' x-go-name: VaultName vaultType: description: 'Specifies the type of the Archival External Target such as ''kCloud'', ''kTape'' or ''kNas''. ''kCloud'' indicates the archival location as Cloud. ''kTape'' indicates the archival location as Tape. ''kNas'' indicates the archival location as Network Attached Storage (Nas).' type: - string - 'null' enum: - kCloud - kTape - kNas x-go-name: VaultType x-go-package: cohesity/iris/server/data/public AdDomainIdentity: description: AD domain identity information. type: object title: AD Domain Identity. properties: dn: description: Specifies distinguished name of the domain. type: - string - 'null' x-go-name: Dn guid: description: Specifies Unique objectGUID for an AD domain. type: - string - 'null' x-go-name: ObjectGuid name: description: Specifies display name of the domain. type: - string - 'null' x-go-name: Name sid: description: Specifies domain SID. type: - string - 'null' x-go-name: Sid x-go-package: cohesity/iris/server/data/public ThrottlingPolicyOverride: description: Specifies throttling policy override for a Datastore in a registered entity. type: object title: Throttling Policy Override. properties: datastoreId: description: Specifies the Protection Source id of the Datastore. type: - integer - 'null' format: int64 x-go-name: DatastoreId datastoreName: description: Specifies the display name of the Datastore. type: - string - 'null' x-go-name: DatastoreName throttlingPolicy: description: Specifies the throttling policy that should be applied to this Source. $ref: '#/components/schemas/ThrottlingPolicyParameters' x-go-package: cohesity/iris/server/data/public DataLockConfig: description: 'Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept for the last N days as specified in the duration of the datalock. During that time, the snapshots cannot be deleted.' type: object properties: daysToKeep: description: 'Specifies last N days to keep Snapshots under datalock in a protection group.' type: - integer - 'null' format: int64 x-go-name: DaysToKeep wormRetentionType: description: 'Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Jobs using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. ''kNone'' implies there is no WORM retention set. ''kCompliance'' implies WORM retention is set for compliance reason. ''kAdministrative'' implies WORM retention is set for administrative purposes.' type: - string - 'null' enum: - kNone - kCompliance - kAdministrative x-go-name: WormRetentionType x-go-package: cohesity/iris/server/data/public NasMountCredentialParams: description: Specifies the credentials to mount a volume on a NetApp server. type: object title: NAS Mount Credentials. properties: domain: description: Specifies the domain in which this credential is valid. type: - string - 'null' x-go-name: Domain domainController: description: Specifies the domain controller for the selected domain type: - string - 'null' x-go-name: DomainController managePasswordByCohesity: description: Specifies if Cohesity can manage the password after registration type: - boolean - 'null' x-go-name: ManagePasswordByCohesity nasProtocol: description: 'Specifies the protocol used by the NAS server. Specifies the protocol used by a NAS server. ''kNfs3'' indicates NFS v3 protocol. ''kCifs1'' indicates CIFS v1.0 protocol.' type: - string - 'null' enum: - kNfs3 - kCifs1 x-go-name: NasProtocol nasType: description: 'Specifies the type of a NAS Object such as ''kGroup'', or ''kHost''. Specifies the kind of NAS mount. ''kGroup'' indicates top level node that holds individual NAS hosts. ''kHost'' indicates a single NAS path that can be mounted. ''kDfsGroup'' indicates a DFS group containing top level directories mapped to different servers. ''kDfsTopDir'' indicates a top level directory inside a DFS group, discovered when registering a DFS group.' type: - string - 'null' enum: - kGroup - kHost - kDfsGroup - kDfsTopDir x-go-name: NasType password: description: Specifies the password for the username to use for mounting the NAS. type: - string - 'null' x-go-name: Password skipValidation: description: 'Specifies the flag to disable mount point validation during registration process.' type: - boolean - 'null' x-go-name: SkipValidation username: description: Specifies a username to use for mounting the NAS. type: - string - 'null' x-go-name: Username x-go-package: cohesity/iris/server/data/public MonthlySchedule: description: 'Specifies a monthly backup schedule by specifying a day in the week and a week in the month. For example, if day is set to ''kMonday'' and dayCount is set to ''kThird'', a Job Run is started on the third Monday of every month.' type: object title: Monthly Schedule. properties: day: description: 'Specifies the day of the week (such as ''kMonday'') to start the Job Run. Used with day count to define the day in the month to start the Job Run. Specifies a day in a week such as ''kSunday'', ''kMonday'', etc.' type: - string - 'null' enum: - kSunday - kMonday - kTuesday - kWednesday - kThursday - kFriday - kSaturday x-go-name: Day dayCount: description: 'Specifies the day count in the month (such as ''kThird'') to start the Job Run. Used in combination with day to define the day in the month to start the Job Run. Specifies the day count in the month to start the backup. For example if day count is set to ''kThird'' and day is set to ''kMonday'', a backup is performed on the third Monday of every month. ''kFirst'' indicates that the first week should be chosen for specified day of every month. ''kSecond'' indicates that the second week should be chosen for specified day of every month. ''kThird'' indicates that the third week should be chosen for specified day of every month. ''kFourth'' indicates that the fourth week should be chosen for specified day of every month. ''kLast'' indicates that the last week should be chosen for specified day of every month.' type: - string - 'null' enum: - kFirst - kSecond - kThird - kFourth - kLast x-go-name: DayCount x-go-package: cohesity/iris/server/data/public NetworkingInformation: description: 'Specifies the struct containing information about network addresses configured on the given box. This is needed for dealing with Windows/Oracle Cluster resources that we discover and protect automatically.' type: object title: Networking Information. properties: resourceVec: description: 'The list of resources on the system that are accessible by an IP address.' type: - array - 'null' items: $ref: '#/components/schemas/ClusterNetworkingResourceInformation' x-go-name: ResourceVec x-go-package: cohesity/iris/server/data/public VMwareObjectId: description: 'Specifies a unique Protection Source id across Cohesity Clusters. It is derived from the id of the VMware Protection Source.' type: object title: VMware Object Id. properties: morItem: description: Specifies the Managed Object Reference Item. type: - string - 'null' x-go-name: MorItem morType: description: Specifies the Managed Object Reference Type. type: - string - 'null' x-go-name: MorType uuid: description: Specifies a Universally Unique Identifier (UUID) of a VMware Object. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public OracleDatabaseNodeChannel: description: 'Specifies node and channel info required for the backup and restore of a database.' type: object title: Oracle Database Node Channel. properties: archiveLogKeepDays: description: Specifies the number of days archive log should be stored. type: - integer - 'null' format: int32 x-go-name: ArchiveLogKeepDays databaseNodeList: description: 'Array of nodes of a database. Specifies the Node info from where we are allowed to take the backup/restore.' type: - array - 'null' items: $ref: '#/components/schemas/OracleDatabaseNode' x-go-name: DatabaseNodeList databaseUniqueName: description: Specifies the unique Name of the database. type: - string - 'null' x-go-name: DatabaseUniqueName databaseUuid: description: 'Specifies the database unique id. This is an internal field and is filled by magneto master based on corresponding app entity id.' type: - string - 'null' x-go-name: DatabaseUuid defaultChannelCount: description: 'Specifies the default number of channels to use per node per database. The default number of channels to use per host per db. This value is used on all OracleDatabaseNode''s unless databaseNodeList item''s channelCount is specified for the node.' type: - integer - 'null' format: int32 x-go-name: DefaultChannelCount enableDgPrimaryBackup: description: 'Specifies whether the database having the Primary role within Data Guard configuration is to be backed up.' type: - boolean - 'null' x-go-name: EnableDgPrimaryBackup maxNodeCount: description: 'Specifies the maximum number of nodes from which we are allowed to take backup/restore.' type: - integer - 'null' format: int32 x-go-name: MaxNodeCount rmanBackupType: description: Specifies the type of Oracle RMAN backup. type: - integer - 'null' format: int32 x-go-name: RmanBackupType x-go-package: cohesity/iris/server/data/public NetappVserverInfo: description: Specifies information about a NetApp Vserver in a NetApp Protection Source. type: object title: NetApp Vserver Information. properties: dataProtocols: description: 'Array of Data Protocols. Specifies the set of data protocols supported by this Vserver. The kManagement protocol is not supported for this case. ''kNfs'' indicates NFS connections. ''kCifs'' indicates SMB (CIFS) connections. ''kIscsi'' indicates iSCSI connections. ''kFc'' indicates Fiber Channel connections. ''kFcache'' indicates Flex Cache connections. ''kHttp'' indicates HTTP connections. ''kNdmp'' indicates NDMP connections. ''kManagement'' indicates non-data connections used for management purposes. ''kNvme'' indicates NVMe connections.' type: - array - 'null' items: type: string enum: - kNfs - kCifs - kIscsi - kFc - kFcache - kHttp - kNdmp - kManagement - kNvme x-go-name: DataProtocols interfaces: description: 'Array of Interfaces. Specifies information about all interfaces on this Vserver.' type: - array - 'null' items: $ref: '#/components/schemas/VserverNetworkInterface' x-go-name: Interfaces rootCifsShare: description: 'Specifies the root ''c$'' CIFS share of this Vserver. If it exists, it can be used to mount all CIFS volumes that are junctioned under ''/'' on this Vserver.' $ref: '#/components/schemas/CifsShareInfo' type: description: 'Specifies the type of this Vserver. Specifies the type of the NetApp Vserver. ''kData'' indicates the Vserver is used for data backup and restore. ''kAdmin'' indicates the Vserver is used for cluster-wide management. ''kSystem'' indicates the Vserver is used for cluster-scoped communications in an IPspace. ''kNode'' indicates the Vserver is used as the physical controller. ''kUnknown'' indicates the Vserver is used for an unknown purpose.' type: - string - 'null' enum: - kData - kAdmin - kSystem - kNode - kUnknown x-go-name: Type x-go-package: cohesity/iris/server/data/public PhysicalEnvJobParameters: description: 'Protection Job parameters applicable to ''kPhysical'' Environment type. Specifies job parameters applicable for all ''kPhysical'' Environment type Protection Sources in a Protection Job.' type: object title: Physical Environment Job Parameters. properties: filePathFilters: description: 'Specifies filters on the backup objects like files and directories. Specifying filters decide which objects within a source should be backed up. If this field is not specified, then all of the objects within the source will be backed up.' $ref: '#/components/schemas/FilePathFilter' incrementalSnapshotUponRestart: description: 'If true, performs an incremental backup after server restarts. Otherwise a full backup is done. NOTE: This is applicable only to Windows servers. If not set, default value is false.' type: - boolean - 'null' x-go-name: IncrementalSnapshotUponRestart x-go-package: cohesity/iris/server/data/public SanStorageArray: description: Specifies a SAN Storage Array. type: object title: SAN Storage Array. properties: id: description: 'Specifies a unique id of a SAN Storage Array. The id is unique across Cohesity Clusters.' type: - string - 'null' x-go-name: Id ports: description: Specifies the SAN ports of the SAN Storage Array. type: - array - 'null' items: $ref: '#/components/schemas/IscsiSanPort' x-go-name: Ports revision: description: Specifies the revision of the SAN Storage Array. type: - string - 'null' x-go-name: Revision version: description: Specifies the version of the SAN Storage Array. type: - string - 'null' x-go-name: Version x-go-package: cohesity/iris/server/data/public CouchbaseBucket: description: Specifies an Object containing information about a couchbase Bucket. type: object title: Couchbase Bucket Info. properties: bucketType: description: Type of this bucket. type: - string - 'null' x-go-name: BucketType documentCount: description: Number of documents in this bucket. type: - integer - 'null' format: int64 x-go-name: DocumentCount x-go-package: cohesity/iris/server/data/public IsilonSmbMountPoint: description: 'Specifies information specific to SMB shares exposed by Isilon file system.' type: object title: Isilon SMB Mount Point. properties: accessZoneId: description: Specifies the Access Zone Id. type: - integer - 'null' format: int64 x-go-name: AccessZoneId description: description: Specifies the description of the NFS mount point. type: - string - 'null' x-go-name: Description shareName: description: Specifies the name of the SMB/CIFS share. type: - string - 'null' x-go-name: ShareName x-go-package: cohesity/iris/server/data/public ExchangeDagHostsResponse: description: 'Specifies if the endpoint provided in the request is standalone exchange server or not. If the endpoint is not a standalone exchange server, the list of hosts which belong to the Exchange DAG are returned.' type: object title: Exchange DAG Hosts Response. properties: exchangeDagProtectionPreference: description: 'Specifies information about the preference order while choosing between which database copy of the exchange database, which is part of DAG, should be protected.' $ref: '#/components/schemas/ExchangeDAGProtectionPreference' exchangeHostInfoList: description: Specifies the list of exchange hosts that belong to Exchange DAG. type: - array - 'null' items: $ref: '#/components/schemas/ExchangeHostInfo' x-go-name: ExchangeHostInfoList guid: description: Specifies the Unique GUID for the DAG. type: - string - 'null' x-go-name: Guid isStandaloneHost: description: 'Specifies if the endpoint provided in the request is a standlone exchange server or not. exchangeHostInfoList is not populated if it is a standalone exchange server.' type: - boolean - 'null' x-go-name: IsStandaloneHost name: description: Specifies the display name of the DAG. type: - string - 'null' x-go-name: Name protectionSourceId: description: 'Specifies the Protection Source Id of the Exchange DAG if it is already created.' type: - integer - 'null' format: int64 x-go-name: ProtectionSourceId x-go-package: cohesity/iris/server/data/public VmwareEnvJobParameters: description: 'Specifies job parameters applicable for all ''kVMware'' Environment type Protection Sources in a Protection Job.' type: object title: Vmware Environment Job Parameters. properties: excludedDisks: description: 'Specifies the list of Disks to be excluded from backing up. These disks are excluded from all Protection Sources in the Protection Job.' type: - array - 'null' items: $ref: '#/components/schemas/DiskUnit' x-go-name: ExcludedDisks fallbackToCrashConsistent: description: 'If true, takes a crash-consistent snapshot when app-consistent snapshot fails. Otherwise, the snapshot attempt is marked failed.' type: - boolean - 'null' x-go-name: FallbackToCrashConsistent skipPhysicalRdmDisks: description: 'If true, skip physical RDM disks when backing up VMs. Otherwise, backup of VMs having physical RDM will fail.' type: - boolean - 'null' x-go-name: SkipPhysicalRdmDisks x-go-package: cohesity/iris/server/data/public UpdateProtectionSourceParameters: description: 'UpdateProtectionSourceParameters defines a public data definition for updating protection source.' type: object title: Update Protection Source Parameters. properties: agentEndpoint: description: Specifies the agent endpoint if it is different from the source endpoint. type: - string - 'null' x-go-name: AgentEndpoint awsCredentials: description: Specifies credentials needed to authenticate with AWS Cloud Platform. title: AWS Source Credentials. $ref: '#/components/schemas/AwsCredentials' awsFleetParams: description: 'Specifies information related to AWS fleets launched for various purposes. This will only be set for kIAMUser entity.' $ref: '#/components/schemas/AwsFleetParams' azureCredentials: description: Specifies credentials needed to authenticate with Azure Cloud Platform. title: Azure Source Credentials. $ref: '#/components/schemas/AzureCredentials' blacklistedIpAddresses: description: 'Specifies the list of IP Addresses on the registered source to be blacklisted for doing any type of IO operations.' type: - array - 'null' items: type: string x-go-name: BlacklistedIpAddresses clusterNetworkInfo: description: 'Specifies information related to cluster. This is only valid for CE clusters. This is only populated for kIAMUser entity.' $ref: '#/components/schemas/FleetNetworkParams' endpoint: description: 'Specifies the network endpoint of the Protection Source where it is reachable. It could be an URL or hostname or an IP address of the Protection Source.' type: - string - 'null' x-go-name: Endpoint exchangeDagProtectionPreference: description: 'Specifies information about the preference order while choosing between which database copy of the exchange database which is part of DAG should be protected.' $ref: '#/components/schemas/ExchangeDAGProtectionPreference' forceRegister: description: 'ForceRegister is applicable to Physical Environment. By default, the agent running on a physical host will fail the registration, if it is already registered as part of another cluster. By setting this option to true, agent can be forced to register with the current cluster. This is a hidden parameter and should not be documented externally.' type: - boolean - 'null' x-go-name: ForceRegister gcpCredentials: description: Specifies credentials needed to authenticate with Google Cloud Platform. title: GCP Source Credentials. $ref: '#/components/schemas/GcpCredentials' hostType: description: 'Specifies the optional OS type of the Protection Source (such as kWindows or kLinux). overrideDescription: true ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: HostType kubernetesCredentials: description: Specifies the credentials needed to authenticate a Kubernetes cluster. title: Kubernetes Source Credentials. $ref: '#/components/schemas/KubernetesCredentials' minimumFreeSpaceGB: description: 'Specifies the minimum space in GB after which backup jobs will be canceled due to low space.' type: - integer - 'null' format: int64 x-go-name: MinimumFreeSpaceGB nasMountCredentials: description: 'Specifies the server credentials to connect to a NetApp server. This field is required for mounting SMB volumes on NetApp servers.' title: NAS Server Credentials. allOf: - $ref: '#/components/schemas/NasMountCredentialParams' office365CredentialsList: description: 'Office365 Source Credentials. Specifies credentials needed to authenticate & authorize user for Office365 using MS Graph APIs.' type: - array - 'null' items: $ref: '#/components/schemas/Office365Credentials' x-go-name: Office365CredentialsList office365Region: description: Specifies the region for Office365. type: - string - 'null' x-go-name: Office365Region password: description: Specifies password of the username to access the target source. type: - string - 'null' x-go-name: Password reRegister: description: 'ReRegister is applicable to Physical Environment. By default, the agent running on a physical host will fail the registration, if it is already registered with the cluster. By setting this option to true, agent can be re-registered with the current cluster.' type: - boolean - 'null' x-go-name: ReRegister sourceSideDedupEnabled: description: 'This controls whether to use source side dedup on the source or not. This is only applicable to sources which support source side dedup (e.g., Linux physical servers).' type: - boolean - 'null' x-go-name: SourceSideDedupEnabled sslVerification: description: 'SSL verification parameter is applicable to VMware environment. It can be populated with the server''s CA certificate or certificate chain and vCenter''s certificate will be validated against this.' $ref: '#/components/schemas/SslVerification' subnets: description: 'Specifies the list of subnet IP addresses and CIDR prefix for enabeling network data transfer. Currently, only Subnet IP and NetbaskBits are valid input fields. All other fields provided as input will be ignored.' type: - array - 'null' items: $ref: '#/components/schemas/Subnet' x-go-name: Subnets throttlingPolicy: description: Specifies the throttling policy that should be applied to this Source. allOf: - $ref: '#/components/schemas/ThrottlingPolicyParameters' throttlingPolicyOverrides: description: 'Array of Throttling Policy Overrides for Datastores. Specifies a list of Throttling Policy for datastores that override the common throttling policy specified for the registered Protection Source. For datastores not in this list, common policy will still apply.' type: - array - 'null' items: $ref: '#/components/schemas/ThrottlingPolicyOverride' x-go-name: ThrottlingPolicyOverrides useOAuthForExchangeOnline: description: 'Specifies whether OAuth should be used for authentication in case of Exchange Online.' type: - boolean - 'null' x-go-name: UseOAuthForExchangeOnline username: description: Specifies username to access the target source. type: - string - 'null' x-go-name: Username vlanParams: description: 'Specifies the VLAN parameters to be used while taking the backup of this entity and is the preferred selection for restoring the same. For restores, the VLAN parameters specifed here can be overridden. Currently, this is only applicable for Physical hosts running Oracle.' $ref: '#/components/schemas/VlanParameters' x-go-package: cohesity/iris/server/data/public ViewProtectionSource: description: Specifies a Protection Source in a View environment. type: object title: View Protection Source. properties: id: description: 'Specifies a unique id of a Protection Source for a View. The id is unique across Cohesity Clusters.' allOf: - $ref: '#/components/schemas/UniversalId' name: description: Specifies a human readable name of the Protection Source of a View. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of managed Object in a View Protection Source environment. Examples of View Objects include ''kViewBox'' or ''kView''. ''kViewBox'' indicates Storage Domain as a Protection Source type. ''kView'' indicates View as a Protection Source type.' type: - string - 'null' enum: - kViewBox - kView x-go-name: Type x-go-package: cohesity/iris/server/data/public RpoSchedule: description: Specifies an RPO Schedule. type: object title: RPO Schedule. properties: intervalUnit: description: 'Specifies an RPO policy interval unit which will be used along with the multiplier to calculate the interval for the RPO policy execution. this can be kHours, kDays, KWeeks, kMonths RPOIntervalUnit. Specifies an RPO Schedule interval unit. kMinutes specifies that the rpo interval unit is hours. kHours specifies that the rpo interval unit is hours. kDays specifies that the rpo interval unit is days. kWeeks specifies that the rpo interval unit is weeks. kMonths specifies that the rpo interval unit is months.' type: - string - 'null' enum: - kMinutes - kHours - kDays - kWeeks - kMonths x-go-name: IntervalUnit multiplier: description: 'Specifies the multiplier value to be used with the RPO interval unit value.' type: - integer - 'null' format: int64 x-go-name: Multiplier x-go-package: cohesity/iris/server/data/public LegalHoldings: description: Specifies the legal holding of a Protection Source. type: object title: Legal Holdings. properties: holdForLegalPurpose: description: Specifies whether the source is put on legal hold or not. type: - boolean - 'null' x-go-name: HoldForLegalPurpose protectionSourceId: description: Specifies an Protection Source Id in the snapshot. type: - integer - 'null' format: int64 x-go-name: ProtectionSourceId x-go-package: cohesity/iris/server/data/public ProtectionSource: description: 'Specifies a generic structure that represents a node in the Protection Source tree. Node details will depend on the environment of the Protection Source.' type: object title: Protection Source. properties: acropolisProtectionSource: description: 'Specifies details about an Acropolis Protection Source when the environment is set to ''kAcropolis''.' allOf: - $ref: '#/components/schemas/AcropolisProtectionSource' adProtectionSource: description: 'Specifies details about an AD Protection Source when the environment is set to ''kAD''.' allOf: - $ref: '#/components/schemas/AdProtectionSource' awsProtectionSource: description: 'Specifies details about an AWS Protection Source when the environment is set to ''kAWS''.' allOf: - $ref: '#/components/schemas/AwsProtectionSource' azureProtectionSource: description: 'Specifies details about an Azure Protection Source when the environment is set to ''kAzure''.' allOf: - $ref: '#/components/schemas/AzureProtectionSource' cassandraProtectionSource: description: 'Specifies details about a Cassandra Protection Source when the environment is set to ''kCassandra''.' allOf: - $ref: '#/components/schemas/CassandraProtectionSource' couchbaseProtectionSource: description: 'Specifies details about a Couchbase Protection Source when the environment is set to ''kCouchbase''.' allOf: - $ref: '#/components/schemas/CouchbaseProtectionSource' elastifileProtectionSource: description: 'Specifies details about a Elastifile Protection Source when the environment is set to ''kElastifile''.' allOf: - $ref: '#/components/schemas/ElastifileProtectionSource' environment: description: 'Specifies the environment (such as ''kVMware'' or ''kSQL'') where the Protection Source exists. Depending on the environment, one of the following Protection Sources are initialized. NOTE: kPuppeteer refers to Cohesity''s Remote Adapter. Supported environment types such as ''kView'', ''kSQL'', ''kVMware'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter. ''kVMware'' indicates the VMware Protection Source environment. ''kHyperV'' indicates the HyperV Protection Source environment. ''kSQL'' indicates the SQL Protection Source environment. ''kView'' indicates the View Protection Source environment. ''kPuppeteer'' indicates the Cohesity''s Remote Adapter. ''kPhysical'' indicates the physical Protection Source environment. ''kPure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''kAzure'' indicates the Microsoft''s Azure Protection Source environment. ''kNetapp'' indicates the Netapp Protection Source environment. ''kAgent'' indicates the Agent Protection Source environment. ''kGenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''kAcropolis'' indicates the Acropolis Protection Source environment. ''kPhsicalFiles'' indicates the Physical Files Protection Source environment. ''kIsilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''kGPFS'' indicates IBM''s GPFS Protection Source environment. ''kKVM'' indicates the KVM Protection Source environment. ''kAWS'' indicates the AWS Protection Source environment. ''kExchange'' indicates the Exchange Protection Source environment. ''kHyperVVSS'' indicates the HyperV VSS Protection Source environment. ''kOracle'' indicates the Oracle Protection Source environment. ''kGCP'' indicates the Google Cloud Platform Protection Source environment. ''kFlashBlade'' indicates the Flash Blade Protection Source environment. ''kAWSNative'' indicates the AWS Native Protection Source environment. ''kO365'' indicates the Office 365 Protection Source environment. ''kO365Outlook'' indicates Office 365 outlook Protection Source environment. ''kHyperFlex'' indicates the Hyper Flex Protection Source environment. ''kGCPNative'' indicates the GCP Native Protection Source environment. ''kAzureNative'' indicates the Azure Native Protection Source environment. ''kKubernetes'' indicates a Kubernetes Protection Source environment. ''kElastifile'' indicates Elastifile Protection Source environment. ''kAD'' indicates Active Directory Protection Source environment. ''kRDSSnapshotManager'' indicates AWS RDS Protection Source environment. ''kCassandra'' indicates Cassandra Protection Source environment. ''kMongoDB'' indicates MongoDB Protection Source environment. ''kCouchbase'' indicates Couchbase Protection Source environment. ''kHdfs'' indicates Hdfs Protection Source environment. ''kHive'' indicates Hive Protection Source environment. ''kHBase'' indicates HBase Protection Source environment.' type: - string - 'null' enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kNimble - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kAzureNative - kKubernetes - kElastifile - kAD - kRDSSnapshotManager - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase x-go-name: Environment exchangeProtectionSource: description: 'Specifies details about an Exchange Protection Source when the environment is set to ''kExchange''.' allOf: - $ref: '#/components/schemas/ExchangeProtectionSource' flashBladeProtectionSource: description: 'Specifies details about a Pure Storage FlashBlade Protection Source when the environment is set to ''kFlashBlade''.' allOf: - $ref: '#/components/schemas/FlashBladeProtectionSource' gcpProtectionSource: description: 'Specifies details about an GCP Protection Source when the environment is set to ''kGCP''.' allOf: - $ref: '#/components/schemas/GcpProtectionSource' gpfsProtectionSource: description: 'Specifies details about an GPFS Protection Source when the environment is set to ''kGPFS''.' allOf: - $ref: '#/components/schemas/GpfsProtectionSource' hbaseProtectionSource: description: 'Specifies details about a HBase Protection Source when the environment is set to ''kHBase''.' allOf: - $ref: '#/components/schemas/HBaseProtectionSource' hdfsProtectionSource: description: 'Specifies details about a Hdfs Protection Source when the environment is set to ''kHdfs''.' allOf: - $ref: '#/components/schemas/HdfsProtectionSource' hiveProtectionSource: description: 'Specifies details about a Hive Protection Source when the environment is set to ''kHive''.' allOf: - $ref: '#/components/schemas/HiveProtectionSource' hyperFlexProtectionSource: description: 'Specifies details about a HyperFlex Storage Snapshot source when the environment is set to ''kHyperFlex''' allOf: - $ref: '#/components/schemas/HyperFlexProtectionSource' hypervProtectionSource: description: 'Specifies details about a HyperV Protection Source when the environment is set to ''kHyperV''.' allOf: - $ref: '#/components/schemas/HypervProtectionSource' id: description: Specifies an id of the Protection Source. type: - integer - 'null' format: int64 x-go-name: Id isilonProtectionSource: description: 'Specifies details about an Isilon OneFs Protection Source when the environment is set to ''kIsilon''.' allOf: - $ref: '#/components/schemas/IsilonProtectionSource' kubernetesProtectionSource: description: 'Specifies details about a Kubernetes Protection Source when the environment is set to ''kKubernetes''.' allOf: - $ref: '#/components/schemas/KubernetesProtectionSource' kvmProtectionSource: description: 'Specifies details about a KVM Protection Source when the environment is set to ''kKVM''.' allOf: - $ref: '#/components/schemas/KvmProtectionSource' mongodbProtectionSource: description: 'Specifies details about a MongoDB Protection Source when the environment is set to ''kMongoDB''.' allOf: - $ref: '#/components/schemas/MongoDBProtectionSource' name: description: Specifies a name of the Protection Source. type: - string - 'null' x-go-name: Name nasProtectionSource: description: 'Specifies details about a Generic NAS Protection Source when the environment is set to ''kGenericNas''.' allOf: - $ref: '#/components/schemas/NasProtectionSource' netappProtectionSource: description: 'Specifies details about a NetApp Protection Source when the environment is set to ''kNetapp''.' allOf: - $ref: '#/components/schemas/NetappProtectionSource' nimbleProtectionSource: description: 'Specifies details about a SAN Protection Source when the environment is set to ''kNimble''.' allOf: - $ref: '#/components/schemas/NimbleProtectionSource' office365ProtectionSource: description: 'Specifies details about an Office 365 Protection Source when the environment is set to ''kO365''.' allOf: - $ref: '#/components/schemas/Office365ProtectionSource' oracleProtectionSource: description: 'Specifies details about an Oracle Protection Source when the environment is set to ''kOracle''.' allOf: - $ref: '#/components/schemas/OracleProtectionSource' parentId: description: Specifies an id of the parent of the Protection Source. type: - integer - 'null' format: int64 x-go-name: ParentId physicalProtectionSource: description: 'Specifies details about a Physical Protection Source when the environment is set to ''kPhysical''.' allOf: - $ref: '#/components/schemas/PhysicalProtectionSource' pureProtectionSource: description: 'Specifies details about a Pure Protection Source when the environment is set to ''kPure''.' allOf: - $ref: '#/components/schemas/PureProtectionSource' sqlProtectionSource: description: 'Specifies details about a SQL Protection Source when the environment is set to ''kSQL''.' allOf: - $ref: '#/components/schemas/SqlProtectionSource' viewProtectionSource: description: 'Specifies details about a View Protection Source when the environment is set to ''kView''.' allOf: - $ref: '#/components/schemas/ViewProtectionSource' vmWareProtectionSource: description: 'Specifies details about a VMware Protection Source when the environment is set to ''kVMware''.' allOf: - $ref: '#/components/schemas/VMwareProtectionSource' x-go-package: cohesity/iris/server/data/public CifsShareInfo: description: Specifies information about a CIFS share of a NetApp volume. type: object title: CIFS Share Information. properties: acls: description: 'Array of Access Control Lists. Specifies the ACLs for this share.' type: - array - 'null' items: type: string x-go-name: Acls name: description: 'Specifies the name of the CIFS share. This can be different from the volume name that this share belongs to. A single volume can export multiple CIFS shares, each with unique settings such as permissions.' type: - string - 'null' x-go-name: Name path: description: Specifies the path of this share under the Vserver's root. type: - string - 'null' x-go-name: Path serverName: description: 'Specifies the CIFS server name (such as ''NETAPP-01'') specified by the system administrator. This name is searchable within the active directory domain.' type: - string - 'null' x-go-name: ServerName x-go-package: cohesity/iris/server/data/public MongoDBCluster: description: Specifies an Object containing information about a mongodb cluster. type: object title: MongoDB Cluster Info. properties: seeds: description: Seeds of this MongoDB Cluster. type: - array - 'null' items: type: string x-go-name: Seeds x-go-package: cohesity/iris/server/data/public EnvironmentTypeJobParameters: description: 'Specifies additional parameters that are common to all Protection Sources in a Protection Job created for a particular environment type.' type: object title: Environment Specific Common Job Parameters. properties: awsSnapshotParameters: description: 'Specifies additional special parameters that are applicable only to snaphot manger jobs.' $ref: '#/components/schemas/AwsSnapshotManagerParameters' exchangeParameters: description: 'Specifies additional special parameters that are applicable only to Types of ''kExchange'' type.' $ref: '#/components/schemas/ExchangeEnvJobParameters' hypervParameters: description: 'Specifies additional special parameters that are applicable only to Types of ''kHyperV'' type.' $ref: '#/components/schemas/HypervEnvJobParameters' nasParameters: description: 'Specifies additional special parameters that are applicable only to Types of ''kGenericNas'' type.' $ref: '#/components/schemas/NasEnvJobParameters' office365Parameters: description: 'Specifies additional special parameters that are applicable only to types of ''kO365Outlook'' type which incorporates both Mailbox & OneDrive backup parameters.' $ref: '#/components/schemas/Office365EnvJobParameters' oracleParameters: description: 'Specifies additional special parameters that are applicable only to Types of ''kOracle'' type.' $ref: '#/components/schemas/OracleEnvJobParameters' physicalParameters: description: 'Specifies additional special parameters that are applicable only to Sources of ''kPhysical'' type in a kPhysical environment.' $ref: '#/components/schemas/PhysicalEnvJobParameters' pureParameters: description: 'Specifies additional special parameters that are applicable only to SAN Types.' $ref: '#/components/schemas/SanEnvJobParameters' sqlParameters: description: 'Specifies additional special parameters that are applicable only to Types of ''kSQL'' type.' $ref: '#/components/schemas/SqlEnvJobParameters' vmwareParameters: description: 'Specifies additional special parameters that are applicable only to Types of ''kVMware'' type.' $ref: '#/components/schemas/VmwareEnvJobParameters' x-go-package: cohesity/iris/server/data/public HypervEnvJobParameters: description: 'Specifies job parameters applicable for all ''kHyperV'' Environment type Protection Sources in a Protection Job.' type: object title: Hyperv Environment Job Parameters. properties: fallbackToCrashConsistent: description: 'If true, takes a crash-consistent snapshot when app-consistent snapshot fails. Otherwise, the snapshot attempt is marked failed. By default, this field is set to false.' type: - boolean - 'null' x-go-name: FallbackToCrashConsistent x-go-package: cohesity/iris/server/data/public OracleSbtHostParams: type: object title: Message to capture Oracle SBT host info. properties: sbtLibraryPath: description: The path of sbt library, This is set only when backup type is kSbt. type: - string - 'null' x-go-name: SbtLibraryPath viewFsPath: description: Cohesity view path. type: - string - 'null' x-go-name: ViewFsPath vipVec: description: Vector of Cohesity primary VIPs. type: - array - 'null' items: type: string x-go-name: VipVec vlanInfoVec: description: Vlan information for Cohesity cluster. type: - array - 'null' items: $ref: '#/components/schemas/OracleVlanInfo' x-go-name: VlanInfoVec x-go-package: magneto/base/env_params.pb CassandraPortsInfo: description: Specifies an Object containing information on various Cassandra ports. type: object title: Cassandra Ports Info. properties: jmxPort: description: Specifies the Cassandra JMX port. type: - integer - 'null' format: uint32 x-go-name: JmxPort nativeTransportPort: description: Specifies the port for the CQL native transport. type: - integer - 'null' format: uint32 x-go-name: NativeTransportPort rpcPort: description: 'Specifies the Remote Procedure Call (RPC) port for general mechanism for client-server applications.' type: - integer - 'null' format: uint32 x-go-name: RpcPort sslStoragePort: description: Specifies the SSL port for encrypted communication. type: - integer - 'null' format: uint32 x-go-name: SslStoragePort storagePort: description: Specifies the TCP port for data. Internally used by Cassandra bulk loader. type: - integer - 'null' format: uint32 x-go-name: StoragePort x-go-package: cohesity/iris/server/data/public MongoDBProtectionSource: description: Specifies an Object representing MongoDB. type: object title: MongoDB Protection Source. properties: clusterInfo: description: 'Information of a mongodb cluster, only valid for an entity of type kCluster.' $ref: '#/components/schemas/MongoDBCluster' collectionInfo: description: 'Information about a mongodb collection, only valid for an entity of type kCollection.' $ref: '#/components/schemas/MongoDBCollection' databaseInfo: description: 'Information of a mongodb database, only valid for an entity of type kDatabase.' $ref: '#/components/schemas/MongoDBDatabase' name: description: Specifies the instance name of the MongoDB entity. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of the managed Object in MongoDB Protection Source. Specifies the type of an MongoDB source entity. ''kCluster'' indicates a mongodb cluster distributed over several physical nodes. ''kDatabase'' indicates a Database within the MongoDB environment. ''kCollection'' indicates a Collection in the MongoDB enironment.' type: - string - 'null' enum: - kCluster - kDatabase - kCollection x-go-name: Type uuid: description: Specifies the UUID for the MongoDB entity. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public OracleSession: description: Specifies information about session configuration for an Oracle host. type: object title: Oracle Session. properties: location: description: Location is the path where Oracle is installed. type: - string - 'null' x-go-name: Location systemIdentifier: description: 'SystemIdentifier is the unique Oracle System Identifier for the DB instance.' type: - string - 'null' x-go-name: SystemIdentifier x-go-package: cohesity/iris/server/data/public AdDomainController: description: Specifies information about an AD domain controller. type: object title: AD Domain Controller. properties: backupSupported: description: Specifies whether backup of this domain controller is supported. type: - boolean - 'null' x-go-name: BackupSupported backupUnsupportedReasons: description: Specifies any reason(s) for domain controller backup not supported. type: - array - 'null' items: type: string x-go-name: BackupUnsupportedReasons domain: description: Specifies Domain hosted on this domain controller. $ref: '#/components/schemas/AdDomain' hostName: description: Specifies FQDN host name of the domain controller. type: - string - 'null' x-go-name: HostName isGlobalCatalog: description: Specifies whether this domain controller is a global catalog server. type: - boolean - 'null' x-go-name: IsGlobalCatalog isReadOnly: description: Specifies whether this domain controller is read only. type: - boolean - 'null' x-go-name: IsReadOnly utcOffsetMin: description: Specifies UTC time offset of this domain controller in minutes. type: - integer - 'null' format: int32 x-go-name: UtcOffsetMin x-go-package: cohesity/iris/server/data/public GcpProtectionSource: description: Specifies a Protection Source in GCP environment. type: object title: GCP Protection Source. properties: clientEmailAddress: description: Specifies Client email address associated with the service account. type: - string - 'null' x-go-name: ClientEmailAddress clientPrivateKey: description: Specifies Client private associated with the service account. type: - string - 'null' x-go-name: ClientPrivateKey gcpType: description: 'Specifies the entity type such as ''kIAMUser'' if the environment is kGCP. Specifies the type of a GCP source entity. ''kIAMUser'' indicates a unique user within a GCP account. ''kProject'' represents compute resources and storage. ''kRegion'' indicates a geographical region in the global infrastructure. ''kAvailabilityZone'' indicates an availability zone within a region. ''kVirtualMachine'' indicates a Virtual Machine running in GCP environment. ''kVPC'' indicates a virtual private cloud (VPC) network within GCP. ''kSubnet'' indicates a subnet inside the VPC. ''kNetworkSecurityGroup'' represents a network security group. ''kInstanceType'' represents various machine types. ''kLabel'' represents a label present on the instances. ''kMetaData'' represents a custom metadata present on instances. ''kTag'' represents a network tag on instances. ''kVPCConnector'' represents a VPC connector used for serverless VPC access.' type: - string - 'null' enum: - kIAMUser - kProject - kRegion - kAvailabilityZone - kVirtualMachine - kVPC - kSubnet - kNetworkSecurityGroup - kInstanceType - kLabel - kMetadata - kTag - kVPCConnector x-go-name: GcpType hostProjectId: description: 'Specifies the host project id. It is populated in entities of type kSubnet if the subnet is part of a shared VPC. This contains the ID of host project the subnet belongs to. Populated in entities of type kProject if the project is a service project in a Shared VPC setup. This contains the ID of the host project it is attached to.' type: - string - 'null' x-go-name: HostProjectId hostType: description: 'Specifies the OS type of the Protection Source of type ''kVirtualMachine'' such as ''kWindows'' or ''kLinux''. overrideDescription: true ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: HostType ipAddressesVM: description: Specifies the IP address of the entity of type 'kVirtualMachine'. type: - string - 'null' x-go-name: IpAddressVM name: description: 'Specifies the name of the Object set by the Cloud Provider. If the provider did not set a name for the object, this field is not set.' type: - string - 'null' x-go-name: Name ownerId: description: 'Specifies the owner id of the resource in GCP environment. With type, name and ownerId gives a globally unique identity to the GCP entity.' type: - string - 'null' x-go-name: OwnerId physicalSourceId: description: 'Specifies the Protection Source id of the registered Physical Host. If the cloud entity is protected using a Physical Agent, it must be registered as a physical host.' type: - integer - 'null' format: int64 x-go-name: PhysicalSourceId projectId: description: 'Specifies the project Id. For the kIAMUser entity this contains the id of the project to be used to deploy proxy VMs. For entities of type kVirtualMachine this contains the id of the project the virtual machine belongs to.' type: - string - 'null' x-go-name: ProjectId regionId: description: 'Specifies the region Id. For the kIAMUser entity this contains the region to be used to deploy proxy VMs. For entities of type kVirtualMachine this contains the region the virtual machine belongs to.' type: - string - 'null' x-go-name: RegionId resourceId: description: Specifies the unique Id of the resource given by the cloud provider. type: - string - 'null' x-go-name: ResourceId restoreTaskId: description: 'Specifies the id of the "convert and deploy" restore task that created the entity in the cloud. It is required to support the DR-to-cloud usecase where we replicate an on-prem entity to a cluster running in cloud, bring it up using "convert and deploy" mechanism, protect it using a cloud job that uses physical adapter, and convert it back to the on-prem format before replication. Before replicating, we need to update the backup task state of the backed up entity using the on-prem entity and on-prem entity''s parent. The id is used to lookup the restore entity that contains details about the on-prem entity. It is set at the time of refreshing the cloud entity hierarchy if all the following conditions are met: Name of the current entity matches with name of any cloud entity deployed using the "convert and deploy" restore task. Restore entity associated with the above matched cloud entity has ''failed_over'' flag set to true in its cloud extension.' type: - integer - 'null' format: int64 x-go-name: RestoreTaskId tagAttributes: description: Specifies the list of GCP tag attributes. type: - array - 'null' items: $ref: '#/components/schemas/TagAttribute' x-go-name: TagAttributes type: description: 'Specifies the type of an GCP Protection Source Object such as ''kIAMUser'', ''kProject'', ''kRegion'', etc. Specifies the type of a GCP source entity. ''kIAMUser'' indicates a unique user within a GCP account. ''kProject'' represents compute resources and storage. ''kRegion'' indicates a geographical region in the global infrastructure. ''kAvailabilityZone'' indicates an availability zone within a region. ''kVirtualMachine'' indicates a Virtual Machine running in GCP environment. ''kVPC'' indicates a virtual private cloud (VPC) network within GCP. ''kSubnet'' indicates a subnet inside the VPC. ''kNetworkSecurityGroup'' represents a network security group. ''kInstanceType'' represents various machine types. ''kLabel'' represents a label present on the instances. ''kMetaData'' represents a custom metadata present on instances. ''kTag'' represents a network tag on instances. ''kVPCConnector'' represents a VPC connector used for serverless VPC access.' type: - string - 'null' enum: - kIAMUser - kProject - kRegion - kAvailabilityZone - kVirtualMachine - kVPC - kSubnet - kNetworkSecurityGroup - kInstanceType - kLabel - kMetadata - kTag - kVPCConnector x-go-name: Type vpcNetwork: description: Specifies the VPC Network to deploy proxy VMs. type: - string - 'null' x-go-name: VpcNetwork vpcSubnetwork: description: Specifies the subnetwork to deploy proxy VMs. type: - string - 'null' x-go-name: VpcSubnetwork x-go-package: cohesity/iris/server/data/public ProtectionRunInstance: description: 'Specifies the status of one Job Run. A Job Run can have one Backup Run and zero or more Copy Runs.' type: object title: Protection Job Run Instance. properties: backupRun: description: 'Specifies details about the Backup task. A Backup task captures the original backup snapshots.' $ref: '#/components/schemas/BackupRun' copyRun: description: 'Array of Copy Run Tasks. Specifies details about the Copy tasks of this Job Run. A Copy task copies the captured snapshots to an external target or a Remote Cohesity Cluster.' type: - array - 'null' items: $ref: '#/components/schemas/CopyRun' x-go-name: CopyRuns jobId: description: Specifies the id of the Protection Job that was run. type: - integer - 'null' format: int64 x-go-name: JobId jobName: description: Specifies the name of the Protection Job name that was run. type: - string - 'null' x-go-name: JobName jobUid: description: Specifies the globally unique id of the Protection Job that was run. allOf: - $ref: '#/components/schemas/UniversalId' protectionShellInfo: description: 'Specifies the shell information about the protection run. This will only be populated if OnlyReturnShellInfo is sent as true.' $ref: '#/components/schemas/ProtectionShellInfo' viewBoxId: description: 'Specifies the Storage Domain (View Box) to store the backed up data. Specify the id of the Storage Domain (View Box).' type: - integer - 'null' format: int64 x-go-name: ViewBoxId x-go-package: cohesity/iris/server/data/public TenantInfo: description: Specifies struct with basic tenant details. type: object title: Tenant Information. properties: name: description: Specifies name of the tenant. type: - string - 'null' x-go-name: Name tenantId: description: Specifies the unique id of the tenant. type: - string - 'null' x-go-name: TenantId x-go-package: cohesity/iris/server/data/public UpdateApplicationServerParameters: description: 'Specifies the parameters required to modify the parameters of previously registered Application Servers in a Protection Source.' type: object title: Update Application Server Parameters. properties: applications: description: 'Specifies the types of applications such as ''kSQL'', ''kExchange'', ''kAD'' running on the Protection Source. overrideDescription: true Supported environment types such as ''kView'', ''kSQL'', ''kVMware'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter. ''kVMware'' indicates the VMware Protection Source environment. ''kHyperV'' indicates the HyperV Protection Source environment. ''kSQL'' indicates the SQL Protection Source environment. ''kView'' indicates the View Protection Source environment. ''kPuppeteer'' indicates the Cohesity''s Remote Adapter. ''kPhysical'' indicates the physical Protection Source environment. ''kPure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''kAzure'' indicates the Microsoft''s Azure Protection Source environment. ''kNetapp'' indicates the Netapp Protection Source environment. ''kAgent'' indicates the Agent Protection Source environment. ''kGenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''kAcropolis'' indicates the Acropolis Protection Source environment. ''kPhsicalFiles'' indicates the Physical Files Protection Source environment. ''kIsilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''kGPFS'' indicates IBM''s GPFS Protection Source environment. ''kKVM'' indicates the KVM Protection Source environment. ''kAWS'' indicates the AWS Protection Source environment. ''kExchange'' indicates the Exchange Protection Source environment. ''kHyperVVSS'' indicates the HyperV VSS Protection Source environment. ''kOracle'' indicates the Oracle Protection Source environment. ''kGCP'' indicates the Google Cloud Platform Protection Source environment. ''kFlashBlade'' indicates the Flash Blade Protection Source environment. ''kAWSNative'' indicates the AWS Native Protection Source environment. ''kO365'' indicates the Office 365 Protection Source environment. ''kO365Outlook'' indicates Office 365 outlook Protection Source environment. ''kHyperFlex'' indicates the Hyper Flex Protection Source environment. ''kGCPNative'' indicates the GCP Native Protection Source environment. ''kAzureNative'' indicates the Azure Native Protection Source environment. ''kKubernetes'' indicates a Kubernetes Protection Source environment. ''kElastifile'' indicates Elastifile Protection Source environment. ''kAD'' indicates Active Directory Protection Source environment. ''kRDSSnapshotManager'' indicates AWS RDS Protection Source environment. ''kCassandra'' indicates Cassandra Protection Source environment. ''kMongoDB'' indicates MongoDB Protection Source environment. ''kCouchbase'' indicates Couchbase Protection Source environment. ''kHdfs'' indicates Hdfs Protection Source environment. ''kHive'' indicates Hive Protection Source environment. ''kHBase'' indicates HBase Protection Source environment.' type: - array - 'null' items: type: string enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kNimble - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kAzureNative - kKubernetes - kElastifile - kAD - kRDSSnapshotManager - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase x-go-name: Applications hasPersistentAgent: description: 'Set this to true if a persistent agent is running on the host. If this is specified, then credentials would not be used to log into the host environment. This mechanism may be used in environments such as VMware to get around UAC permission issues by running the agent as a service with the right credentials. If this field is not specified, credentials must be specified.' type: - boolean - 'null' x-go-name: HasPersistentAgent password: description: Specifies password of the username to access the target source. type: - string - 'null' x-go-name: Password protectionSourceId: description: 'Specifies the Id of the Protection Source that contains one or more Application Servers running on it.' type: - integer - 'null' format: int64 x-go-name: ProtectionSourceId username: description: Specifies username to access the target source. type: - string - 'null' x-go-name: Username x-go-package: cohesity/iris/server/data/public Subnet: description: 'Defines a Subnet (Subnetwork). The netmask can be specified by setting netmaskBits or netmaskIp4. The netmask can only be set using netmaskIp4 if the IP address is an IPv4 address.' type: object title: Subnet properties: component: description: Component that has reserved the subnet. type: - string - 'null' x-go-name: Component description: description: Description of the subnet. type: - string - 'null' x-go-name: Description id: description: ID of the subnet. type: - integer - 'null' format: int32 x-go-name: Id ip: description: Specifies either an IPv6 address or an IPv4 address. type: - string - 'null' x-go-name: Ip netmaskBits: description: Specifies the netmask using bits. type: - integer - 'null' format: int32 x-go-name: NetmaskBits netmaskIp4: description: 'Specifies the netmask using an IP4 address. The netmask can only be set using netmaskIp4 if the IP address is an IPv4 address.' type: - string - 'null' x-go-name: NetmaskIp4 nfsAccess: description: 'Specifies whether clients from this subnet can mount using NFS protocol. Protocol access level. ''kDisabled'' indicates Protocol access level ''Disabled'' ''kReadOnly'' indicates Protocol access level ''ReadOnly'' ''kReadWrite'' indicates Protocol access level ''ReadWrite''' type: - string - 'null' enum: - kDisabled - kReadOnly - kReadWrite x-go-name: NfsAccess nfsAllSquash: description: 'Specifies whether all clients from this subnet can map view with view_all_squash_uid/view_all_squash_gid configured in the view.' type: - boolean - 'null' x-go-name: NfsAllSquash nfsRootSquash: description: Specifies whether clients from this subnet can mount as root on NFS. type: - boolean - 'null' x-go-name: NfsRootSquash smbAccess: description: 'Specifies whether clients from this subnet can mount using SMB protocol. Protocol access level. ''kDisabled'' indicates Protocol access level ''Disabled'' ''kReadOnly'' indicates Protocol access level ''ReadOnly'' ''kReadWrite'' indicates Protocol access level ''ReadWrite''' type: - string - 'null' enum: - kDisabled - kReadOnly - kReadWrite x-go-name: SmbAccess x-go-package: cohesity/iris/server/data/public GpfsCluster: description: Specifies information about a GPFS Cluster. type: object title: GPFS Cluster. properties: cesAddresses: description: 'Specifies a list of CES(Cluster Export Services) IP addresses of a GPFS Cluster.' type: - array - 'null' items: type: string x-go-name: CesAddresses id: description: Specifies a globally unique id of a GPFS Cluster. type: - integer - 'null' format: uint64 x-go-name: Id primaryServer: description: Specifies a primary server of a GPFS Cluster. type: - string - 'null' x-go-name: PrimaryServer x-go-package: cohesity/iris/server/data/public HyperFlexProtectionSource: description: Specifies a Storage Snapshot Provider in a HyperFlex environment. type: object title: HyperFlex Storae Snapshot. properties: name: description: Specifies a unique name of the Protection Source type: - string - 'null' x-go-name: Name productVersion: description: Specifies the product version of the protection source. type: - string - 'null' x-go-name: ProductVersion type: description: 'Specifies the type of managed Object in a HyperFlex protection source like kServer. Examples of a HyperFlex types include ''kServer''. ''kServer'' indicates HyperFlex server entity.' type: - string - 'null' enum: - kServer x-go-name: Type uuid: description: Specifies the uuid of the protection source. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public DailySchedule: description: Specifies a daily or weekly backup schedule. type: object title: Daily & Weekly Schedule. properties: days: description: 'Array of Days. Specifies a list of days of the week when to start Job Runs. If no days are specified, the Jobs Runs will run every day of the week. Specifies a day in a week such as ''kSunday'', ''kMonday'', etc.' type: - array - 'null' items: type: string enum: - kSunday - kMonday - kTuesday - kWednesday - kThursday - kFriday - kSaturday x-go-name: Days x-go-package: cohesity/iris/server/data/public UpgradePhysicalAgentsMessage: description: Specifies the status of an upgrade request. type: object title: Status of Physical Upgrade Request. properties: message: description: 'Specifies the status message returned after initiating an upgrade request. Status of each agent upgrade can be obtained by listing Physical Servers using the GET /public/protectionSources operation.' type: - string - 'null' x-go-name: Message x-go-package: cohesity/iris/server/data/public PhysicalVolume: description: Specifies volume information about a Physical Protection Source. type: object title: Physical Volume. properties: devicePath: description: Specifies the path to the device that hosts the volume locally. type: - string - 'null' x-go-name: DevicePath guid: description: Specifies an id for the Physical Volume. type: - string - 'null' x-go-name: Guid isBootVolume: description: Specifies whether the volume is boot volume. type: - boolean - 'null' x-go-name: IsBootVolume isExtendedAttributesSupported: description: 'Specifies whether this volume supports extended attributes (like ACLs) when performing file backups.' type: - boolean - 'null' x-go-name: IsExtendedAttributesSupported isProtected: description: Specifies if a volume is protected by a Job. type: - boolean - 'null' x-go-name: IsProtected isSharedVolume: description: Specifies whether the volume is shared volume. type: - boolean - 'null' x-go-name: IsSharedVolume label: description: 'Specifies a volume label that can be used for displaying additional identifying information about a volume.' type: - string - 'null' x-go-name: Label logicalSizeBytes: description: 'Specifies the logical size of the volume in bytes that is not reduced by change-block tracking, compression and deduplication.' type: - integer - 'null' format: uint64 x-go-name: LogicalSizeBytes mountPoints: description: 'Array of Mount Points. Specifies the mount points where the volume is mounted, for example: ''C:\'', ''/mnt/foo'' etc.' type: - array - 'null' items: type: string x-go-name: MountPoints mountType: description: Specifies mount type of volume e.g. nfs, autofs, ext4 etc. type: - string - 'null' x-go-name: MountType networkPath: description: 'Specifies the full path to connect to the network attached volume. For example, (IP or hostname):/path/to/share for NFS volumes).' type: - string - 'null' x-go-name: NetworkPath usedSizeBytes: description: Specifies the size used by the volume in bytes. type: - integer - 'null' format: uint64 x-go-name: UsedSizeBytes x-go-package: cohesity/iris/server/data/public ProtectionSummary: description: 'Specifies the number of protected and unprotected objects, and their sizes information of the given entity.' type: object title: Protection Summary. properties: protectedCount: description: 'Specifies the number of objects that are protected under the given entity.' type: - integer - 'null' format: int64 x-go-name: ProtectedCount protectedSize: description: Specifies the total size of the protected objects under the given entity. type: - integer - 'null' format: int64 x-go-name: ProtectedSize unprotectedCount: description: 'Specifies the number of objects that are not protected under the given entity.' type: - integer - 'null' format: int64 x-go-name: UnprotectedCount unprotectedSize: description: 'Specifies the total size of the unprotected objects under the given entity.' type: - integer - 'null' format: int64 x-go-name: UnprotectedSize x-go-package: cohesity/iris/server/data/public ApplicationParameters: type: object title: Application specific parameters. properties: truncateExchangeLog: description: 'If true, after the Cohesity Cluster successfully captures a Snapshot during a Job Run, the Cluster truncates the Exchange transaction logs on a Microsoft Exchange Server. The default value is false.' type: - boolean - 'null' x-go-name: TruncateExchangeLog x-go-package: cohesity/iris/server/data/public AggregatedSubtreeInfo: description: Aggregated information about a node subtree. type: object title: Aggregated Subtree Info. properties: environment: description: 'Specifies the environment such as ''kSQL'' or ''kVMware'', where the Protection Source exists. Supported environment types such as ''kView'', ''kSQL'', ''kVMware'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter. ''kVMware'' indicates the VMware Protection Source environment. ''kHyperV'' indicates the HyperV Protection Source environment. ''kSQL'' indicates the SQL Protection Source environment. ''kView'' indicates the View Protection Source environment. ''kPuppeteer'' indicates the Cohesity''s Remote Adapter. ''kPhysical'' indicates the physical Protection Source environment. ''kPure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''kAzure'' indicates the Microsoft''s Azure Protection Source environment. ''kNetapp'' indicates the Netapp Protection Source environment. ''kAgent'' indicates the Agent Protection Source environment. ''kGenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''kAcropolis'' indicates the Acropolis Protection Source environment. ''kPhsicalFiles'' indicates the Physical Files Protection Source environment. ''kIsilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''kGPFS'' indicates IBM''s GPFS Protection Source environment. ''kKVM'' indicates the KVM Protection Source environment. ''kAWS'' indicates the AWS Protection Source environment. ''kExchange'' indicates the Exchange Protection Source environment. ''kHyperVVSS'' indicates the HyperV VSS Protection Source environment. ''kOracle'' indicates the Oracle Protection Source environment. ''kGCP'' indicates the Google Cloud Platform Protection Source environment. ''kFlashBlade'' indicates the Flash Blade Protection Source environment. ''kAWSNative'' indicates the AWS Native Protection Source environment. ''kO365'' indicates the Office 365 Protection Source environment. ''kO365Outlook'' indicates Office 365 outlook Protection Source environment. ''kHyperFlex'' indicates the Hyper Flex Protection Source environment. ''kGCPNative'' indicates the GCP Native Protection Source environment. ''kAzureNative'' indicates the Azure Native Protection Source environment. ''kKubernetes'' indicates a Kubernetes Protection Source environment. ''kElastifile'' indicates Elastifile Protection Source environment. ''kAD'' indicates Active Directory Protection Source environment. ''kRDSSnapshotManager'' indicates AWS RDS Protection Source environment. ''kCassandra'' indicates Cassandra Protection Source environment. ''kMongoDB'' indicates MongoDB Protection Source environment. ''kCouchbase'' indicates Couchbase Protection Source environment. ''kHdfs'' indicates Hdfs Protection Source environment. ''kHive'' indicates Hive Protection Source environment. ''kHBase'' indicates HBase Protection Source environment.' type: - string - 'null' enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kNimble - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kAzureNative - kKubernetes - kElastifile - kAD - kRDSSnapshotManager - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase x-go-name: Environment leavesCount: description: Specifies the number of leaf nodes under the subtree of this node. type: - integer - 'null' format: int64 x-go-name: LeavesCount totalLogicalSize: description: 'Specifies the total logical size of the data under the subtree of this node.' type: - integer - 'null' format: int64 x-go-name: TotalLogicalSize x-go-package: cohesity/iris/server/data/public ApplicationInfo: description: Specifies the application registered on the Cohesity Cluster. type: object title: Application Information. properties: applicationTreeInfo: description: 'Application Server and the subtrees below them. Specifies the application subtree used to store additional application level Objects. Different environments use the subtree to store application level information. For example for SQL Server, this subtree stores the SQL Server instances running on a VM or a Physical Server. overrideDescription: true' type: - array - 'null' items: $ref: '#/components/schemas/ProtectionSourceNode' x-go-name: ApplicationTreeInfo environment: description: 'Specifies the environment type of the application such as ''kSQL'', ''kExchange'' registered on the Protection Source. overrideDescription: true Supported environment types such as ''kView'', ''kSQL'', ''kVMware'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter. ''kVMware'' indicates the VMware Protection Source environment. ''kHyperV'' indicates the HyperV Protection Source environment. ''kSQL'' indicates the SQL Protection Source environment. ''kView'' indicates the View Protection Source environment. ''kPuppeteer'' indicates the Cohesity''s Remote Adapter. ''kPhysical'' indicates the physical Protection Source environment. ''kPure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''kAzure'' indicates the Microsoft''s Azure Protection Source environment. ''kNetapp'' indicates the Netapp Protection Source environment. ''kAgent'' indicates the Agent Protection Source environment. ''kGenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''kAcropolis'' indicates the Acropolis Protection Source environment. ''kPhsicalFiles'' indicates the Physical Files Protection Source environment. ''kIsilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''kGPFS'' indicates IBM''s GPFS Protection Source environment. ''kKVM'' indicates the KVM Protection Source environment. ''kAWS'' indicates the AWS Protection Source environment. ''kExchange'' indicates the Exchange Protection Source environment. ''kHyperVVSS'' indicates the HyperV VSS Protection Source environment. ''kOracle'' indicates the Oracle Protection Source environment. ''kGCP'' indicates the Google Cloud Platform Protection Source environment. ''kFlashBlade'' indicates the Flash Blade Protection Source environment. ''kAWSNative'' indicates the AWS Native Protection Source environment. ''kO365'' indicates the Office 365 Protection Source environment. ''kO365Outlook'' indicates Office 365 outlook Protection Source environment. ''kHyperFlex'' indicates the Hyper Flex Protection Source environment. ''kGCPNative'' indicates the GCP Native Protection Source environment. ''kAzureNative'' indicates the Azure Native Protection Source environment. ''kKubernetes'' indicates a Kubernetes Protection Source environment. ''kElastifile'' indicates Elastifile Protection Source environment. ''kAD'' indicates Active Directory Protection Source environment. ''kRDSSnapshotManager'' indicates AWS RDS Protection Source environment. ''kCassandra'' indicates Cassandra Protection Source environment. ''kMongoDB'' indicates MongoDB Protection Source environment. ''kCouchbase'' indicates Couchbase Protection Source environment. ''kHdfs'' indicates Hdfs Protection Source environment. ''kHive'' indicates Hive Protection Source environment. ''kHBase'' indicates HBase Protection Source environment.' type: - string - 'null' enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kNimble - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kAzureNative - kKubernetes - kElastifile - kAD - kRDSSnapshotManager - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase x-go-name: Environment x-go-package: cohesity/iris/server/data/public DataLockConstraints: description: Specifies the datalock retention type and expiry time when datalock expires type: object title: DataLock Constraints properties: expiryTimeUsecs: description: 'Specifies expiry time to keep Snapshots under datalock in a protection group.' type: - integer - 'null' format: int64 x-go-name: ExpiryTimeUsecs wormRetentionType: description: 'Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Jobs using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. ''kNone'' implies there is no WORM retention set. ''kCompliance'' implies WORM retention is set for compliance reason. ''kAdministrative'' implies WORM retention is set for administrative purposes.' type: - string - 'null' enum: - kNone - kCompliance - kAdministrative x-go-name: WormRetentionType x-go-package: cohesity/iris/server/data/public NetappProtectionSource: description: Specifies a Protection Source in a NetApp environment. type: object title: NetApp Protection Source. properties: clusterInfo: description: 'Specifies information about a NetApp cluster and is only valid for a NetApp Object of type kCluster.' $ref: '#/components/schemas/NetappClusterInfo' isTopLevel: description: 'Specifies if this Object is a top level Object. Because a top level Object can either be a NetApp cluster or a Vserver, this cannot be determined only by type.' type: - boolean - 'null' x-go-name: IsTopLevel licenseTypes: description: 'Specifies the type of license available on Netapp Cluster ''kSnapmirrorCloud'' indicates a SnapMirror license on Netapp.' type: - array - 'null' items: type: string enum: - kSnapmirrorCloud x-go-name: LicenseTypes name: description: Specifies the name of the NetApp Object. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of managed NetApp Object in a NetApp Protection Source such as ''kCluster'', ''kVserver'' or ''kVolume''. ''kCluster'' indicates a Netapp cluster as a protection source. ''kVserver'' indicates a Netapp vserver in a cluster as a protection source. ''kVolume'' indicates a volume in Netapp vserver as a protection source.' type: - string - 'null' enum: - kCluster - kVserver - kVolume x-go-name: Type uuid: description: 'Specifies the globally unique ID of this Object assigned by the NetApp server.' type: - string - 'null' x-go-name: Uuid version: description: Specifies the version of Netapp Cluster. type: - string - 'null' x-go-name: Version volumeInfo: description: 'Specifies information about a NetApp volume and is only valid for a NetApp Object of type kVolume.' $ref: '#/components/schemas/NetappVolumeInfo' vserverInfo: description: 'Specifies information about a NetApp Vserver and is only valid for a NetApp Object of type kVserver.' $ref: '#/components/schemas/NetappVserverInfo' x-go-package: cohesity/iris/server/data/public RemoteScriptPathAndParams: description: 'Specifies the path to the remote script and any parameters expected by the remote script.' type: object title: Remote Script. properties: continueOnError: description: 'Specifies if the script needs to continue even if there is an occurence of an error. If this flag is set to true, then backup job will start even if the pre backup script fails. Applicable only for pre backup scripts.' type: - boolean - 'null' x-go-name: ContinueOnError isActive: description: 'Specifies if the script is active. If 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: 'Specifies the parameters and values to pass into the remote script. For example if the script expects values for the ''database'' and ''user'' parameters, specify the parameters and values using the following string: "database=myDatabase user=me".' type: - string - 'null' x-go-name: ScriptParams scriptPath: description: Specifies the path to the script on the remote host. type: - string - 'null' x-go-name: ScriptPath timeoutSecs: description: 'Specifies the timeout of the script in seconds. The script will be killed if it exceeds this value. If the value of the field is ''-1'' then timeout is not set for the script.' type: - integer - 'null' format: int32 x-go-name: TimeoutSecs x-go-package: cohesity/iris/server/data/public SnapshotReplicationCopyPolicy: description: 'Specifies settings for copying Snapshots to Remote Clusters. This also specifies the retention policy that should be applied to Snapshots after they have been copied to the specified target.' type: object title: Snapshot Copy Replication Policy. properties: Id: description: 'Specified the Id for a snapshot copy policy. This is generated when the policy is created.' type: - string - 'null' cloudTarget: description: Specifies the cloud replication target to copy the Snapshots to. $ref: '#/components/schemas/CloudDeployTargetDetails' copyPartial: description: 'Specifies if Snapshots are copied from the first completely successful Job Run or the first partially successful Job Run occurring at the start of the replication schedule. If true, Snapshots are copied from the first Job Run occurring at the start of the replication schedule, even if first Job Run was not completely successful i.e. Snapshots were not captured for all Objects in the Job. If false, Snapshots are copied from the first Job Run occurring at the start of the replication schedule that was completely successful i.e. Snapshots for all the Objects in the Job were successfully captured.' type: - boolean - 'null' x-go-name: CopyPartial datalockConfig: description: 'Specifies WORM retention type for the copy target snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept for the last N days as specified in the duration of the datalock. During that time, the snapshots cannot be deleted.' $ref: '#/components/schemas/DataLockConfig' daysToKeep: description: Specifies the number of days to retain copied Snapshots on the target. type: - integer - 'null' format: int64 x-go-name: DaysToKeep multiplier: description: 'Specifies a factor to multiply the periodicity by, to determine the copy schedule. For example if set to 2 and the periodicity is hourly, then Snapshots from the first eligible Job Run for every 2 hour period is copied.' type: - integer - 'null' format: int32 x-go-name: Multiplier periodicity: description: 'Specifies the frequency that Snapshots should be copied to the specified target. Used in combination with multiplier. ''kEvery'' means that the Snapshot copy occurs after the number of Job Runs equals the number specified in the multiplier. ''kHour'' means that the Snapshot copy occurs hourly at the frequency set in the multiplier, for example if multiplier is 2, the copy occurs every 2 hours. ''kDay'' means that the Snapshot copy occurs daily at the frequency set in the multiplier. ''kWeek'' means that the Snapshot copy occurs weekly at the frequency set in the multiplier. ''kMonth'' means that the Snapshot copy occurs monthly at the frequency set in the multiplier. ''kYear'' means that the Snapshot copy occurs yearly at the frequency set in the multiplier.' type: - string - 'null' enum: - kEvery - kHour - kDay - kWeek - kMonth - kYear x-go-name: Periodicity target: description: Specifies the replication target to copy the Snapshots to. allOf: - $ref: '#/components/schemas/ReplicationTargetSettings' x-go-package: cohesity/iris/server/data/public RegisteredAppInfo: type: object properties: authenticationErrorMessage: description: 'Specifies an authentication error message. This indicates the given credentials are rejected and the registration of the application is not successful.' type: - string - 'null' x-go-name: AuthenticationErrorMessage authenticationStatus: description: 'Specifies the status of authenticating to the Protection Source when registering this application with Cohesity Cluster. If the status is ''kFinished'' and there is no error, registration is successful. Specifies the status of the authentication during the registration of a Protection Source. ''kPending'' indicates the authentication is in progress. ''kScheduled'' indicates the authentication is scheduled. ''kFinished'' indicates the authentication is completed. ''kRefreshInProgress'' indicates the refresh is in progress.' type: - string - 'null' enum: - kPending - kScheduled - kFinished - kRefreshInProgress x-go-name: AuthenticationStatus environment: description: 'Specifies the application environment. Supported environment types such as ''kView'', ''kSQL'', ''kVMware'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter. ''kVMware'' indicates the VMware Protection Source environment. ''kHyperV'' indicates the HyperV Protection Source environment. ''kSQL'' indicates the SQL Protection Source environment. ''kView'' indicates the View Protection Source environment. ''kPuppeteer'' indicates the Cohesity''s Remote Adapter. ''kPhysical'' indicates the physical Protection Source environment. ''kPure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''kAzure'' indicates the Microsoft''s Azure Protection Source environment. ''kNetapp'' indicates the Netapp Protection Source environment. ''kAgent'' indicates the Agent Protection Source environment. ''kGenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''kAcropolis'' indicates the Acropolis Protection Source environment. ''kPhsicalFiles'' indicates the Physical Files Protection Source environment. ''kIsilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''kGPFS'' indicates IBM''s GPFS Protection Source environment. ''kKVM'' indicates the KVM Protection Source environment. ''kAWS'' indicates the AWS Protection Source environment. ''kExchange'' indicates the Exchange Protection Source environment. ''kHyperVVSS'' indicates the HyperV VSS Protection Source environment. ''kOracle'' indicates the Oracle Protection Source environment. ''kGCP'' indicates the Google Cloud Platform Protection Source environment. ''kFlashBlade'' indicates the Flash Blade Protection Source environment. ''kAWSNative'' indicates the AWS Native Protection Source environment. ''kO365'' indicates the Office 365 Protection Source environment. ''kO365Outlook'' indicates Office 365 outlook Protection Source environment. ''kHyperFlex'' indicates the Hyper Flex Protection Source environment. ''kGCPNative'' indicates the GCP Native Protection Source environment. ''kAzureNative'' indicates the Azure Native Protection Source environment. ''kKubernetes'' indicates a Kubernetes Protection Source environment. ''kElastifile'' indicates Elastifile Protection Source environment. ''kAD'' indicates Active Directory Protection Source environment. ''kRDSSnapshotManager'' indicates AWS RDS Protection Source environment. ''kCassandra'' indicates Cassandra Protection Source environment. ''kMongoDB'' indicates MongoDB Protection Source environment. ''kCouchbase'' indicates Couchbase Protection Source environment. ''kHdfs'' indicates Hdfs Protection Source environment. ''kHive'' indicates Hive Protection Source environment. ''kHBase'' indicates HBase Protection Source environment.' type: - string - 'null' enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kNimble - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kAzureNative - kKubernetes - kElastifile - kAD - kRDSSnapshotManager - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase x-go-name: Environment hostSettingsCheckResults: description: 'Specifies the list of check results internally performed to verify status of various services such as ''AgnetRunning'', ''SQLWriterRunning'' etc.' type: - array - 'null' items: $ref: '#/components/schemas/HostSettingsCheckResult' x-go-name: HostSettingsCheckResults refreshErrorMessage: description: 'Specifies a message if there was any error encountered during the last rebuild of the application tree. If there was no error during the last rebuild, this field is reset.' type: - string - 'null' x-go-name: RefreshErrorMessage x-go-package: cohesity/iris/server/data/public HypervDatastore: description: Specifies information about a Datastore Object in HyperV environment. type: object title: HyperV Datastore Object. properties: capacity: description: Specifies the capacity of the datastore in bytes. type: - integer - 'null' format: uint64 x-go-name: Capacity freeSpace: description: Specifies the available space on the datastore in bytes. type: - integer - 'null' format: uint64 x-go-name: FreeSpace mountPoints: description: Specifies the available mount points on the datastore. type: - array - 'null' items: type: string x-go-name: MountPoints type: description: 'Specifies the type of the datastore object like kFileShare or kVolume. overrideDescription: true Specifies the type of a HyperV datastore object. ''kFileShare'' indicates SMB file share datastore. ''kVolume'' indicates a volume which can a LUN.' type: - string - 'null' enum: - kFileShare - kVolume x-go-name: Type x-go-package: cohesity/iris/server/data/public DbFileInfo: description: Specifies information about a database file. type: object title: Database File Information. properties: fileType: description: 'Specifies the format type of the file that SQL database stores the data. Specifies the format type of the file that SQL database stores the data. ''kRows'' refers to a data file ''kLog'' refers to a log file ''kFileStream'' refers to a directory containing FILESTREAM data ''kNotSupportedType'' is for information purposes only. Not supported. ''kFullText'' refers to a full-text catalog.' type: - string - 'null' enum: - kRows - kLog - kFileStream - kNotSupportedType - kFullText x-go-name: FileType fullPath: description: Specifies the full path of the database file on the SQL host machine. type: - string - 'null' x-go-name: FullPath sizeBytes: description: Specifies the last known size of the database file. type: - integer - 'null' format: int64 x-go-name: SizeBytes x-go-package: cohesity/iris/server/data/public RpoPolicySettings: description: 'Specifies all the additional settings that are applicable only to an RPO policy. This can include storage domain, settings of different environments, etc.' type: object title: RPO Policy. properties: alertingConfig: description: 'Alerting configuration can be used to specify optional details for the alerts triggered by this policy.' $ref: '#/components/schemas/AlertingConfig' alertingPolicy: description: 'Array of Job Events. During Job Runs, the following Job Events are generated: 1) Job succeeds 2) Job fails 3) Job violates the SLA These Job Events can cause Alerts to be generated. ''kSuccess'' means the Protection Job succeeded. ''kFailure'' means the Protection Job failed. ''kSlaViolation'' means the Protection Job took longer than the time period specified in the SLA.' type: - array - 'null' items: type: string enum: - kSuccess - kFailure - kSlaViolation x-go-name: AlertingPolicy environmentTypeJobParams: description: 'Specifies the policy level additional environment specific backup params. If this is not specified, default actions will be taken, for example for NAS environments, all objects within the source will be backed up.' $ref: '#/components/schemas/EnvironmentTypeJobParameters' indexingPolicy: description: Specifies the indexing policy for objects backed up by this policy. $ref: '#/components/schemas/IndexingPolicy' qosType: description: 'Specifies the QoS policy type to use. ''kBackupHDD'' indicates the Cohesity Cluster writes data directly to the HDD tier for this Protection Job. This is the recommended setting. ''kBackupSSD'' indicates the Cohesity Cluster writes data directly to the SSD tier for this Protection Job. Only specify this policy if you need fast ingest speed for a small number of Protection Jobs.' type: - string - 'null' enum: - kBackupHDD - kBackupSSD x-go-name: QosType storageDomainId: description: Specifies the Storage Domain to which data will be written. type: - integer - 'null' format: int64 x-go-name: StorageDomainId x-go-package: cohesity/iris/server/data/public VserverNetworkInterface: description: 'Specifies information about a logical network interface on a NetApp Vserver. The interface''s IP address is the mount point for a specific data protocol, such as NFS or CIFS.' type: object title: Vserver Network Interface. properties: dataProtocols: description: 'Array of Data Protocols. Specifies the set of data protocols supported by this interface. ''kNfs'' indicates NFS connections. ''kCifs'' indicates SMB (CIFS) connections. ''kIscsi'' indicates iSCSI connections. ''kFc'' indicates Fiber Channel connections. ''kFcache'' indicates Flex Cache connections. ''kHttp'' indicates HTTP connections. ''kNdmp'' indicates NDMP connections. ''kManagement'' indicates non-data connections used for management purposes. ''kNvme'' indicates NVMe connections.' type: - array - 'null' items: type: string enum: - kNfs - kCifs - kIscsi - kFc - kFcache - kHttp - kNdmp - kManagement - kNvme x-go-name: DataProtocols ipAddress: description: Specifies the IP address of this interface. type: - string - 'null' x-go-name: IpAddress name: description: Specifies the name of this interface. type: - string - 'null' x-go-name: Name x-go-package: cohesity/iris/server/data/public SnapshotLabel: description: 'Specifies the snapshot label for incremental and full backup of Secondary Netapp volumes (Data-Protect Volumes).' type: object properties: fullLabel: description: Specifies the full snapshot label value type: - string - 'null' x-go-name: FullLabel incrementalLabel: description: Specifies the incremental snapshot label value type: - string - 'null' x-go-name: IncrementalLabel x-go-package: cohesity/iris/server/data/public ExchangeEnvJobParameters: description: Specifies job parameters applicable for the Exchange Protection Jobs. type: object title: Exchange Environment Job Parameters. properties: backupsCopyOnly: description: Specifies whether the backups should be copy-only. type: - boolean - 'null' x-go-name: BackupsCopyOnly x-go-package: cohesity/iris/server/data/public SnapshotTargetSettings: description: 'Specifies settings about a target where a copied Snapshot is stored. A target can be a Remote Cluster or an Archival External Target such as AWS or Tape.' type: object title: Snapshot Target. properties: archivalTarget: description: 'Specifies the Archival External Target for storing a copied Snapshot. If the type is not ''kLocal'', either a replicationTarget, archivalExternalTarget or cloudReplicationTarget must be specified.' $ref: '#/components/schemas/ArchivalExternalTarget' cloudReplicationTarget: description: 'Specifies the cloud replication target for storing a copied Snapshot. If the type is not ''kLocal'', either a replicationTarget, archivalExternalTarget or cloudReplicationTarget must be specified.' $ref: '#/components/schemas/CloudDeployTargetDetails' replicationTarget: description: 'Specifies the replication target (Remote Cluster) for storing a copied Snapshot. If the type is not ''kLocal'', either a replicationTarget, archivalExternalTarget or cloudReplicationTarget must be specified.' $ref: '#/components/schemas/ReplicationTargetSettings' type: description: 'Specifies the type of a Snapshot target such as ''kLocal'', ''kRemote'' or ''kArchival''. ''kLocal'' means the Snapshot is stored on a local Cohesity Cluster. ''kRemote'' means the Snapshot is stored on a Remote Cohesity Cluster. (It was copied to the Remote Cohesity Cluster using replication.) ''kArchival'' means the Snapshot is stored on a Archival External Target (such as Tape or AWS). ''kCloudDeploy'' means the Snapshot is stored on a Cloud platform.' type: - string - 'null' enum: - kLocal - kRemote - kArchival - kCloudDeploy - kCloudReplication x-go-name: Type x-go-package: cohesity/iris/server/data/public VmwareSpecialParameters: description: 'Specifies additional special settings applicable for a Protection Source of ''kVMware'' type in a Protection Job.' type: object title: Vmware Source Special Job Parameters. properties: applicationParameters: description: 'Specifies parameters that are related to applications running on the Protection Source.' $ref: '#/components/schemas/ApplicationParameters' excludedDisks: description: 'Specifies the list of Disks to be excluded from backing up. These disks are excluded from all Protection Sources in the Protection Job.' type: - array - 'null' items: $ref: '#/components/schemas/DiskUnit' x-go-name: ExcludedDisks vmCredentials: description: 'Specifies the administrator credentials to log in to the guest Windows system of a VM that hosts the Microsoft Exchange Server. If truncateExchangeLog is set to true and the specified source is a VM, administrator credentials to log in to the guest Windows system of the VM must be provided to truncate the logs. This field is only applicable to Sources in the kVMware environment.' title: VM Credentials. allOf: - $ref: '#/components/schemas/Credentials' x-go-package: cohesity/iris/server/data/public FilePathParameters: description: 'Specifies a file or a directory to protect in a Physical Server. If a directory is specified, all of its descendants are also backed up. Optionally, files or subdirectories can be explicitly excluded.' type: object title: File or Directory to Protect. properties: backupFilePath: description: 'Specifies absolute path to a file or a directory in a Physical Server to protect.' type: - string - 'null' x-go-name: BackupFilePath excludedFilePaths: description: 'Array of Excluded File Paths. Specifies absolute paths to descendant files or subdirectories of backupFilePath that should not be protected.' type: - array - 'null' items: type: string x-go-name: ExcludedFilePaths skipNestedVolumes: description: 'Specifies if any subdirectories under backupFilePath, where local or network volumes are mounted, should be excluded from being protected. If true, the volumes are not protected. deprecated: true' type: - boolean - 'null' x-go-name: SkipNestedVolumes x-go-package: cohesity/iris/server/data/public AzureParams: description: Specifies various resources when converting and deploying a VM to Azure. type: object title: Azure Parameters. properties: dataDiskType: description: 'Specifies the disk type used by the data. ''kPremiumSSD'' is disk type backed by SSDs, delivers high performance, low latency disk support for VMs running I/O intensive workloads. ''kStandardSSD'' implies disk type that offers more consistent performance and reliability than HDD. ''kStandardHDD'' implies disk type backed by HDDs, delivers cost effective storage.' type: - string - 'null' enum: - kPremiumSSD - kStandardSSD - kStandardHDD x-go-name: DataDiskType instanceId: description: 'Specifies Type of VM (e.g. small, medium, large) when cloning the VM in Azure.' type: - integer - 'null' format: int64 x-go-name: InstanceId networkResourceGroupId: description: Specifies id of the resource group for the selected virtual network. type: - integer - 'null' format: int64 x-go-name: NetworkResourceGroupId osDiskType: description: 'Specifies the disk type used by the OS. ''kPremiumSSD'' is disk type backed by SSDs, delivers high performance, low latency disk support for VMs running I/O intensive workloads. ''kStandardSSD'' implies disk type that offers more consistent performance and reliability than HDD. ''kStandardHDD'' implies disk type backed by HDDs, delivers cost effective storage.' type: - string - 'null' enum: - kPremiumSSD - kStandardSSD - kStandardHDD x-go-name: OsDiskType resourceGroup: description: 'Specifies id of the Azure resource group. Its value is globally unique within Azure.' type: - integer - 'null' format: int64 x-go-name: ResourceGroup storageAccount: description: 'Specifies id of the storage account that will contain the storage container within which we will create the blob that will become the VHD disk for the cloned VM.' type: - integer - 'null' format: int64 x-go-name: StorageAccount storageContainer: description: Specifies id of the storage container within the above storage account. type: - integer - 'null' format: int64 x-go-name: StorageContainer storageResourceGroupId: description: Specifies id of the resource group for the selected storage account. type: - integer - 'null' format: int64 x-go-name: StorageResourceGroupId subnetId: description: Specifies Id of the subnet within the above virtual network. type: - integer - 'null' format: int64 x-go-name: SubnetId tempVmResourceGroupId: description: Specifies the resource group where temporary VM needs to be created. type: - integer - 'null' format: int64 x-go-name: TempVmResourceGroupId tempVmStorageAccountId: description: Specifies the Storage account where temporary VM needs to be created. type: - integer - 'null' format: int64 x-go-name: TempVmStorageAccountId tempVmStorageContainerId: description: Specifies the Storage container where temporary VM needs to be created. type: - integer - 'null' format: int64 x-go-name: TempVmStorageContainerId tempVmSubnetId: description: Specifies the Subnet where temporary VM needs to be created. type: - integer - 'null' format: int64 x-go-name: TempVmSubnetId tempVmVirtualNetworkId: description: Specifies the Virtual network where temporary VM needs to be created. type: - integer - 'null' format: int64 x-go-name: TempVmVirtualNetworkId virtualNetworkId: description: Specifies Id of the Virtual Network. type: - integer - 'null' format: int64 x-go-name: VirtualNetworkId x-go-package: cohesity/iris/server/data/public 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 CopyRun: description: 'Specifies details about the Copy Run for a backup run of a Job Run. A Copy task copies snapshots resulted from a backup run to a snapshot target which could be ''kLocal'', ''kArchival'', or ''kRemote''.' type: object title: Copy Run Task. properties: copySnapshotTasks: description: 'Specifies the status information of each task that copies the snapshot taken for a Protection Source.' type: - array - 'null' items: $ref: '#/components/schemas/CopySnapshotTaskStatus' x-go-name: CopySnapshotTasks dataLockConstraints: description: Specifies the datalock constraints for a copy run task. $ref: '#/components/schemas/DataLockConstraints' error: description: 'Specifies if an error occurred (if any) while running this task. This field is populated when the status is equal to ''kFailure''.' type: - string - 'null' x-go-name: Error expiryTimeUsecs: description: 'Specifies expiry time of the copies of the snapshots in this Protection Run.' type: - integer - 'null' format: int64 x-go-name: ExpiryTimeUsecs holdForLegalPurpose: description: 'Specifies whether legal hold is enabled on this run. It is true if the run is put on legal hold. Independent of this flag, some of the entities may be on legal hold.' type: - boolean - 'null' x-go-name: HoldForLegalPurpose legalHoldings: description: Specifies the list of Protection Source Ids and the legal hold status. type: - array - 'null' items: $ref: '#/components/schemas/LegalHoldings' x-go-name: LegalHoldings runStartTimeUsecs: description: Specifies start time of the copy run. type: - integer - 'null' format: int64 x-go-name: RunStartTimeUsecs stats: description: Specifies the aggregated information of all the copy tasks. $ref: '#/components/schemas/CopyRunStats' status: description: 'Specifies the aggregated status of copy tasks such as ''kRunning'', ''kSuccess'', ''kFailure'' etc. ''kAccepted'' indicates the task is queued to run but not yet running. ''kRunning'' indicates the task is running. ''kCanceling'' indicates a request to cancel the task has occurred but the task is not yet canceled. ''kCanceled'' indicates the task has been canceled. ''kSuccess'' indicates the task was successful. ''kFailure'' indicates the task failed. ''kWarning'' indicates the task has finished with warning. ''kOnHold'' indicates the task is kept onHold. ''kMissed'' indicates the task is missed.' type: - string - 'null' enum: - kAccepted - kRunning - kCanceling - kCanceled - kSuccess - kFailure - kWarning - kOnHold - kMissed x-go-name: Status target: description: 'Specifies the target of the copy task such as an external target or a Remote Cohesity Cluster.' $ref: '#/components/schemas/SnapshotTargetSettings' taskUid: description: Specifies a globally unique id of the copy task. allOf: - $ref: '#/components/schemas/UniversalId' userActionMessage: description: 'Specifies a message to the user if any manual intervention is needed to make forward progress for the archival task. This message is mainly relevant for tape based archival tasks where a backup admin might be asked to load a new media when the tape library does not have any more media to use.' type: - string - 'null' x-go-name: UserActionMessage x-go-package: cohesity/iris/server/data/public OracleSpecialParameters: description: Specifies special settings applicable for 'kOracle' environment. type: object title: Oracle Special Parameters. properties: appParamsList: description: 'Array of application parameters i.e. database parameters for standalone/RAC and DG parameters for data guard. Specifies the list of parameters required at app entity level.' type: - array - 'null' items: $ref: '#/components/schemas/OracleAppParams' x-go-name: AppParamsList applicationEntityIds: description: 'Array of Ids of Application Entities like Oracle instances, and databases that should be protected in a Protection Source. Specifies the subset of application entities like Oracle instances, and databases to protect in a Protection Source of type kOracle''. If not specified, all application entities on the Protection Source.' type: - array - 'null' items: type: integer format: int64 x-go-name: ApplicationEntityIds persistMountpoints: description: 'Specifies if the mountpoints for Oracle view for the current host are to be persisted.' type: - boolean - 'null' x-go-name: PersistMountpoints x-go-package: cohesity/iris/server/data/public IndexingPolicy: description: 'Specifies settings for indexing files found in an Object (such as a VM) so these files can be searched and recovered. This also specifies inclusion and exclusion rules that determine the directories to index.' type: object title: Indexing Policy. properties: allowPrefixes: description: 'Array of Indexed Directories. Specifies a list of directories to index.' type: - array - 'null' items: type: string x-go-name: AllowPrefixes denyPrefixes: description: 'Array of Excluded Directories. Specifies a list of directories to exclude from indexing.' type: - array - 'null' items: type: string x-go-name: DenyPrefixes disableIndexing: description: 'Specifies if the files found in an Object (such as a VM) should be indexed. If false (the default), files are indexed.' type: - boolean - 'null' x-go-name: DisableIndexing x-go-package: cohesity/iris/server/data/public Office365UserInfo: description: Specifies information about an Office365 user. type: object title: Office 365 User Info. properties: city: description: Specifies the city in which the Office365 user is located. type: - string - 'null' x-go-name: City country: description: Specifies the country/region in which the Office365 user is located. type: - string - 'null' x-go-name: Country department: description: Specifies the department within the enterprise of the Office365 user. type: - string - 'null' x-go-name: Department designation: description: Specifies the designation of the Office365 user. type: - string - 'null' x-go-name: Designation graphUuid: description: Specifies the MS Graph UUID for the given user entity. type: - string - 'null' x-go-name: GraphUuid mailboxSize: description: 'Specifies the size of the Outlook Mailbox associated with this Office365 entity.' type: - integer - 'null' format: int64 x-go-name: MailboxSize oneDriveId: description: 'Specifies the Id of the OneDrive associated with the this Office 365 entity.' type: - string - 'null' x-go-name: OneDriveId oneDriveSize: description: Specifies the size of the OneDrive associated with this Office365 entity. type: - integer - 'null' format: int64 x-go-name: OneDriveSize x-go-package: cohesity/iris/server/data/public OracleContainerDatabaseInfo: description: 'Specifies the Container Database information along with the Pluggable DBs within the container. The multitenant architecture enables an Oracle database to function as a multitenant container database (CDB). A CDB includes zero, one, or many customer-created pluggable databases (PDBs).' type: object properties: pluggableDatabaseInfoList: description: Specifies the list of Pluggable databases within this Container Database. type: - array - 'null' items: $ref: '#/components/schemas/OraclePluggableDatabaseInfo' x-go-name: PluggableDatabaseInfoList x-go-package: cohesity/iris/server/data/public ExchangeDAGProtectionPreference: description: 'Specifies the information about the preference order while choosing between which database copy of the database which is part of DAG should be protected.' type: object title: Exchange DAG Backup preference properties: passiveCopyPreferenceServerGuidList: description: 'Specifies the preference order of the exchange servers from which passive database copies should be protected. The preference order is descending which indicates that passive database copy in the first server in the list gets the highest preference.' type: - array - 'null' items: type: string x-go-name: PassiveCopyPreferenceServerGuidList passiveOnly: description: 'Specifies that only passive database copies should be protected if this is set to true. If this is set to false, both active and passive database copies can be protected.' type: - boolean - 'null' x-go-name: PassiveOnly useUserSpecifiedPassivePreferenceOrder: description: 'Specifies to use the user specified preference order of exchange servers from which the passive database copies should be protected if this is set to true. Every copy of an Exchange database in a DAG is assigned an activation preference number. This number is used by the system as part of the passive database activation process. If this bool flag is set to false, the reverse order of activation is used while choosing between passive copies.' type: - boolean - 'null' x-go-name: UseUserSpecifiedPassivePreferenceOrder x-go-package: cohesity/iris/server/data/public NetappVolumeInfo: description: Specifies information about a volume in a NetApp cluster. type: object title: NetApp Volume Information. properties: aggregateName: description: Specifies the containing aggregate name of this volume. type: - string - 'null' x-go-name: AggregateName capacityBytes: description: Specifies the total capacity in bytes of this volume. type: - integer - 'null' format: int64 x-go-name: CapacityBytes cifsShares: description: 'Array of CIFS Shares. Specifies the set of CIFS Shares exported for this volume.' type: - array - 'null' items: $ref: '#/components/schemas/CifsShareInfo' x-go-name: CifsShares creationTimeUsecs: description: 'Specifies the creation time of the volume specified in Unix epoch time (in microseconds).' type: - integer - 'null' format: int64 x-go-name: CreationTimeUsecs dataProtocols: description: 'Array of Data Protocols. Specifies the set of data protocols supported by this volume. ''kNfs'' indicates NFS connections. ''kCifs'' indicates SMB (CIFS) connections. ''kIscsi'' indicates iSCSI connections. ''kFc'' indicates Fiber Channel connections. ''kFcache'' indicates Flex Cache connections. ''kHttp'' indicates HTTP connections. ''kNdmp'' indicates NDMP connections. ''kManagement'' indicates non-data connections used for management purposes. ''kNvme'' indicates NVMe connections.' type: - array - 'null' items: type: string enum: - kNfs - kCifs - kIscsi - kFc - kFcache - kHttp - kNdmp - kManagement - kNvme x-go-name: DataProtocols exportPolicyName: description: 'Specifies the name of the export policy (which defines the access permissions for the mount client) that has been assigned to this volume.' type: - string - 'null' x-go-name: ExportPolicyName junctionPath: description: 'Specifies the junction path of this volume. This path can be used to mount this volume via protocols such as NFS.' type: - string - 'null' x-go-name: JunctionPath name: description: Specifies the name of the NetApp Vserver that this volume belongs to. type: - string - 'null' x-go-name: Name securityInfo: description: Specifies the security information of this volume. $ref: '#/components/schemas/VolumeSecurityInfo' state: description: 'Specifies the state of this volume. Specifies the state of a NetApp Volume. ''kOnline'' indicates the volume is online. Read and write access to this volume is allowed. ''kRestricted'' indicates the volume is restricted. Some operations, such as parity reconstruction, are allowed, but data access is not allowed. ''kOffline'' indicates the volume is offline. No access to the volume is allowed. ''kMixed'' indicates the volume is in mixed state, which means its aggregates are not all in the same state.' type: - string - 'null' enum: - kOnline - kRestricted - kOffline - kMixed x-go-name: State type: description: 'Specifies the NetApp type of this volume. Specifies the type of a NetApp Volume. ''kReadWrite'' indicates read-write volume. ''kLoadSharing'' indicates load-sharing volume. ''kDataProtection'' indicates data-protection volume. ''kDataCache'' indicates data-cache volume. ''kTmp'' indicates temporary purpose. ''kUnknownType'' indicates unknown type.' type: - string - 'null' enum: - kReadWrite - kLoadSharing - kDataProtection - kDataCache - kTmp - kUnknownType x-go-name: Type usedBytes: description: Specifies the total space (in bytes) used in this volume. type: - integer - 'null' format: int64 x-go-name: UsedBytes x-go-package: cohesity/iris/server/data/public VdcCatalog: description: Specifies a VDC Catalog. type: object title: VDC Catalog required: - uuid properties: uuid: description: Specifies the UUID of the catalog. type: - string - 'null' x-order: 0 name: description: Specifies the name of the catalog. type: - string - 'null' x-order: 1 readOnly: true Sources: description: Protection Sources. type: object properties: sources: description: Specifies the list of Protection Sources. type: - array - 'null' items: $ref: '#/components/schemas/Source' x-order: 0 CassandraPortInfo: description: Contains info about specific cassandra ports. type: object title: Cassandra specific port info. properties: nativeTransportPort: description: Port for the CQL native transport. type: - integer - 'null' format: int32 x-order: 0 rpcPort: description: Remote Procedure Call (RPC) port for general mechanism for client-server applications. type: - integer - 'null' format: int32 x-order: 1 storagePort: description: TCP port for data. Internally used by Cassandra bulk loader. type: - integer - 'null' format: int32 x-order: 2 sslStoragePort: description: SSL port for encrypted communication. Internally used by the Cassandra bulk loader. type: - integer - 'null' format: int32 x-order: 3 jmxPort: description: Cassandra management port. type: - integer - 'null' format: int32 x-order: 4 VdcObject: description: Specifies the details about VMware Virtual datacenter. type: object properties: catalogs: description: Specifies a list of VDC Catalogs. type: array items: $ref: '#/components/schemas/VdcCatalog' x-order: 0 orgNetworks: description: Specifies a list of Organization VDC Networks. type: array items: $ref: '#/components/schemas/OrgVDCNetwork' x-order: 1 VmwareObjectEntityParams: description: Object details for Vmware. type: object properties: type: description: VMware Object type. type: - string - 'null' enum: - kVCenter - kStandaloneHost - kvCloudDirector - kFolder - kDatacenter - kComputeResource - kClusterComputeResource - kResourcePool - kDatastore - kHostSystem - kVirtualMachine - kVirtualApp - kStoragePod - kNetwork - kDistributedVirtualPortgroup - kTagCategory - kTag - kOpaqueNetwork - kOrganization - kVirtualDatacenter - kCatalog - kOrgMetadata - kStoragePolicy - kVirtualAppTemplate x-order: 0 cdpInfo: description: Specifies the Continuous Data Protection (CDP) details about this object. This is only available if this object if protected by a CDP enabled policy. type: - object - 'null' x-order: 1 $ref: '#/components/schemas/VmwareCdpObject' isTemplate: description: Specifies if the object is a VM template. type: - boolean - 'null' x-order: 2 SourceConnectionRequestParams: description: Specifies the parameters to test connectivity with a source. type: object title: Test connection request parameters. required: - environment properties: environment: description: Specifies the environment type of the Protection Source. type: - string - 'null' enum: - kCassandra - kHive - kHBase - kHdfs - kSQL x-order: 0 cassandraConnectionParams: description: Specifies the parameters to connect to a Cassandra seed node and fetch information from its cassandra config file. type: - object - 'null' x-order: 1 $ref: '#/components/schemas/CassandraConnectionParams' hiveConnectionParams: description: Specifies the parameters to connect to a hive seed node and fetch information from its config file. type: - object - 'null' x-order: 2 $ref: '#/components/schemas/HadoopConnectionParams' hbaseConnectionParams: description: Specifies the parameters to connect to a HBase seed node and fetch information from its config file. type: - object - 'null' x-order: 3 $ref: '#/components/schemas/HadoopConnectionParams' hdfsConnectionParams: description: Specifies the parameters to connect to a HDFS seed node and fetch information from its config file. type: - object - 'null' x-order: 4 $ref: '#/components/schemas/HadoopConnectionParams' mssqlConnectionParams: description: Specifies the parameters to connect to a SQL node/cluster and fetch connection status information of all nodes. type: - object - 'null' x-order: 5 $ref: '#/components/schemas/MssqlConnectionParams' vmwareConnectionParams: description: Specifies the parameters to connect to a HDFS seed node and fetch information from its config file. type: - object - 'null' x-order: 6 $ref: '#/components/schemas/VmwareConnectionParams' ObjectSummary: description: Specifies the Object Summary. title: Object Summary allOf: - $ref: '#/components/schemas/ObjectIdentifier' - type: object properties: objectHash: description: Specifies the hash identifier of the object. type: - string - 'null' x-order: 0 objectType: description: Specifies the type of the object. type: - string - 'null' enum: - kCluster - kVserver - kVolume - kVCenter - kStandaloneHost - kvCloudDirector - kFolder - kDatacenter - kComputeResource - kClusterComputeResource - kResourcePool - kDatastore - kHostSystem - kVirtualMachine - kVirtualApp - kStoragePod - kNetwork - kDistributedVirtualPortgroup - kTagCategory - kTag - kOpaqueNetwork - kOrganization - kVirtualDatacenter - kCatalog - kOrgMetadata - kStoragePolicy - kVirtualAppTemplate - kDomain - kOutlook - kMailbox - kUsers - kGroups - kSites - kUser - kGroup - kSite - kApplication - kGraphUser - kPublicFolders - kPublicFolder - kTeams - kTeam - kKeyspace - kTable - kDatabase - kCollection - kBucket - kNamespace - kSCVMMServer - kStandaloneCluster - kHostGroup - kHypervHost - kHostCluster - kCustomProperty - kSubscription - kResourceGroup - kStorageAccount - kStorageKey - kStorageContainer - kStorageBlob - kNetworkSecurityGroup - kVirtualNetwork - kSubnet - kComputeOptions - kSnapshotManagerPermit - kAvailabilitySet - kOVirtManager - kHost - kStorageDomain - kVNicProfile - kIAMUser - kRegion - kAvailabilityZone - kEC2Instance - kVPC - kInstanceType - kKeyPair - kRDSOptionGroup - kRDSParameterGroup - kRDSInstance - kRDSSubnet - kRDSTag - kAuroraCluster - kAccount - kSubTaskPermit - kProject - kLabel - kMetadata - kVPCConnector - kPrismCentral - kOtherHypervisorCluster - kDfsGroup - kDfsTopDir - kZone - kMountPoint - kStorageArray - kFileSystem - kContainer - kFilesystem - kFileset - kViewBox - kView - kWindowsCluster - kOracleRACCluster - kOracleAPCluster - kService - kPVC - kRootContainer - kDAGRootContainer - kExchangeNode - kExchangeDAGDatabaseCopy - kExchangeStandaloneDatabase - kExchangeDAG - kExchangeDAGDatabase - kDomainController - kInstance - kAAG - kAAGRootContainer - kRACRootContainer - kTableSpace - kPDB - kObject x-order: 1 logicalSizeBytes: description: Specifies the logical size of object in bytes. type: - integer - 'null' format: int64 x-order: 2 uuid: description: Specifies the uuid which is a unique identifier of the object. type: - string - 'null' x-order: 3 protectionType: description: Specifies the protection type of the object if any. type: - string - 'null' enum: - kAgent - kNative - kSnapshotManager - kRDSSnapshotManager - kAuroraSnapshotManager - kFile - kVolume x-order: 4 osType: description: Specifies the operating system type of the object. type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-order: 5 vCenterSummary: description: Specifies the vCenter object details. type: - object - 'null' x-order: 6 $ref: '#/components/schemas/ObjectTypeVCenterParams' ObjectTypeVCenterParams: type: object title: Object Type VCenter Params properties: isCloudEnv: description: Specifies that registered vCenter source is a VMC (VMware Cloud) environment or not. type: - boolean - 'null' x-order: 0 CommonNasObjectParams: description: Specifies the common parameters for NAS objects. type: object properties: supportedNasMountProtocols: description: Specifies a list of NAS mount protocols supported by this object. type: - array - 'null' items: type: string enum: - kNoProtocol - kNfs3 - kCifs1 - kCifs2 - kCifs3 x-order: 0 ContainerDatabaseInfo: description: Object details about Oracle container database. type: object properties: pluggableDatabaseList: description: Specifies the list of Pluggable databases within a container database. type: - array - 'null' items: $ref: '#/components/schemas/PluggableDatabaseInfo' x-order: 0 Credentials_2: description: Specifies the object to hold username and password. type: object title: Credentials required: - username - password properties: username: description: Specifies the username to access target entity. type: string x-order: 0 password: description: Specifies the password to access target entity. type: string x-order: 1 Group: description: Specifies a user group object. type: object title: User Group properties: name: description: Specifies the name of the user group. type: - string - 'null' x-order: 0 sid: description: Specifies the sid of the user group. type: - string - 'null' x-order: 1 domain: description: Specifies the domain of the user group. type: - string - 'null' x-order: 2 SourceConnectionResponseParams: description: Specifies the response from a test connection request. type: object title: Test Connection response parameters. required: - environment properties: environment: description: Specifies the environment type of the Protection Source. type: - string - 'null' enum: - kCassandra - kHive - kHBase - kHdfs - kSQL x-order: 0 cassandraConnectionResponseParams: description: Specifies the parameters fetched by reading cassandra configuration on the seed node. type: - object - 'null' x-order: 1 $ref: '#/components/schemas/CassandraSourceConfigParams' hiveConnectionResponseParams: description: Specifies the parameters fetched by reading Hive configuration on the seed node. type: - object - 'null' x-order: 2 $ref: '#/components/schemas/HiveAdditionalParams' hbaseConnectionResponseParams: description: Specifies the parameters fetched by reading HBase configuration on the seed node. type: - object - 'null' x-order: 3 $ref: '#/components/schemas/HBaseAdditionalParams' hdfsConnectionResponseParams: description: Specifies the parameters fetched by reading Hdfs configuration on the seed node. type: - object - 'null' x-order: 4 $ref: '#/components/schemas/HdfsAdditionalParams' mssqlConnectionResponseParams: description: Specifies the response parameters after connecting to a SQL node/cluster using given IP or hostname FQDN. type: - object - 'null' x-order: 5 $ref: '#/components/schemas/MssqlConnectionResponseParams' vmwareConnectionResponseParams: description: Specifies the parameters fetched by reading VMware configuration on the seed node. type: - object - 'null' x-order: 6 $ref: '#/components/schemas/VmwareAdditionalParams' AppResource: description: Specifies the details about App Resource. type: object properties: id: description: Specifies the unique id of the app resource. type: - string - 'null' x-order: 0 type: description: Specifies the type of the app resource. type: - string - 'null' enum: - standaloneServer - windowsCluster - sqlCluster x-order: 1 endpoints: description: Specifies the information about endpoint associated with this resorce. type: - array - 'null' items: $ref: '#/components/schemas/ResourceEndpoint' x-order: 2 AAGGroup: description: Specifies the details of a AAG Group. type: object properties: id: description: Specifies the unique identifier of the AGGGroup. type: - string - 'null' x-order: 0 name: description: Specifies the name of the AAG Group. type: - string - 'null' x-order: 1 resourceInfo: description: Specifies the resource information about the AAG Group. type: - object - 'null' x-order: 2 $ref: '#/components/schemas/AppResource' servers: description: Specifies the list of SQL servers which belongs to the given AAG Group. type: - array - 'null' items: $ref: '#/components/schemas/SQLServer' x-order: 3 fciClusters: description: Specifies the list of FCI clusters which belongs to the given AAG Group. type: - array - 'null' items: $ref: '#/components/schemas/FCICluster' x-order: 4 PermissionInfo: description: Specifies the list of users, groups and users that have permissions for a given object. type: object title: Permissions Information properties: objectId: description: Specifies the id of the object. type: - integer - 'null' format: int64 x-order: 0 users: description: Specifies the list of users which has the permissions to the object. type: - array - 'null' items: $ref: '#/components/schemas/User' x-order: 1 groups: description: Specifies the list of user groups which has permissions to the object. type: - array - 'null' items: $ref: '#/components/schemas/Group' x-order: 2 tenant: description: Specifies the tenant which has access to the object. type: - object - 'null' x-order: 3 $ref: '#/components/schemas/Tenant' PluggableDatabaseInfo: description: Specifies the information about Pluggable databases. type: object properties: databaseId: description: Specifies the database Id of the Pluggable DB. type: - string - 'null' x-order: 0 databaseName: description: Specifies the name of the Pluggable DB. type: - string - 'null' x-order: 1 VcdAdditionalParams: description: Additional params for VCD protection source. type: object title: VCD Additional Params. properties: vcenterInfoList: description: Specifies the list of vCenters associated with this VCD protection source. type: array items: $ref: '#/components/schemas/VcdVcenterInfo' x-order: 0 CassandraSourceConfigParams: description: Specifies the parameters fetched by reading cassandra configuration on the seed node. title: Parameters fetched by reading cassandra config file. properties: seeds: description: Seed nodes of this cluster. type: array items: type: string x-order: 0 isJmxAuthEnable: description: Is JMX Authentication enabled in this cluster ? type: - boolean - 'null' x-order: 1 cassandraPortInfo: description: Info about specific cassandra ports. x-order: 2 $ref: '#/components/schemas/CassandraPortInfo' cassandraSecurityInfo: description: Cassandra security related info. x-order: 3 $ref: '#/components/schemas/CassandraSecurityInfo_2' dataCenterNames: description: Data centers for this cluster. type: array items: type: string x-order: 4 endpointSnitch: description: Endpoint snitch used for this cluster. type: - string - 'null' x-order: 5 cassandraPartitioner: description: Cassandra partitioner required in compaction. type: - string - 'null' x-order: 6 kerberosSaslProtocol: description: Populated if cassandraAuthType is Kerberos. type: - string - 'null' x-order: 7 cassandraVersion: description: Cassandra Version. type: - string - 'null' x-order: 8 dseVersion: description: DSE Version type: - string - 'null' x-order: 9 VmwareAdditionalParams: description: Additional params for VMware protection source. type: object title: VMware Additional Params. properties: vcdParams: description: Specifies the VCD additional params. type: - object - 'null' x-order: 0 $ref: '#/components/schemas/VcdAdditionalParams' VcdVcenterInfo: description: Specifies information about a vCetner. type: object title: VCD vCenter Info properties: name: description: Specifies the name of the vCenter. type: - string - 'null' x-order: 0 endpoint: description: Specifies the endpoint of the vCenter. type: - string - 'null' x-order: 1 CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4: description: Specifies the parameters which are common between all Protection Source registrations. type: object required: - environment properties: environment: description: Specifies the environment type of the Protection Source. type: - string - 'null' enum: - kVMware - kHyperV - kAcropolis - kKVM - kAWS - kGCP - kAzure - kPhysical - kPure - kNimble - kNetapp - kGenericNas - kIsilon - kFlashBlade - kGPFS - kElastifile - kO365 - kHyperFlex - kKubernetes - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase - kUDA x-order: 0 isInternalEncrypted: description: Specifies if credentials are encrypted by internal key. type: - boolean - 'null' x-order: 1 encryptionKey: description: Specifies the key that user has encrypted the credential with. type: - string - 'null' x-order: 2 connectionId: description: Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. type: - integer - 'null' format: int64 x-order: 3 x-cohesity-discriminator-details: propertyName: environment x-discriminator: mapping: kVMware: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4VmwareSourceRegistrationParamsWrapper' kPhysical: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4PhysicalSourceRegistrationParamsWrapper' kGenericNas: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4GenericNasRegistrationParamsWrapper' kIsilon: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4IsilonRegistrationParamsWrapper' kNetapp: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4NetappRegistrationParamsWrapper' kElastifile: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4ElastifileRegistrationParamsWrapper' kFlashBlade: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4FlashbladeRegistrationParamsWrapper' kGPFS: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4GpfsRegistrationParamsWrapper' kCassandra: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4CassandraSourceRegistrationParamsWrapper' kMongoDB: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4MongoDBSourceRegistrationParamsWrapper' kCouchbase: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4CouchbaseSourceRegistrationParamsWrapper' kHdfs: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4HdfsSourceRegistrationParamsWrapper' kHBase: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4HbaseSourceRegistrationParamsWrapper' kHive: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4HiveSourceRegistrationParamsWrapper' kUDA: '#/definitions/CommonSourceRegistrationRequestParams778a2997-dade-4cc3-95a8-40275e1405a4UdaSourceRegistrationParamsWrapper' propertyName: environment NetappObjectParams: description: Specifies the common parameters for Netapp objects. type: object properties: supportedNasMountProtocols: description: Specifies a list of NAS mount protocols supported by this object. type: - array - 'null' items: type: string enum: - kNfs - kCifs - kIscsi - kFc - kFcache - kHttp - kNdmp - kManagement - kNvme x-order: 0 volumeType: description: Specifies the Netapp volume type. type: - string - 'null' enum: - ReadWrite - LoadSharing - DataProtection - DataCache - Temp - UnkownType x-order: 1 HostSettingCheck: description: Specifies the host checking details. type: object properties: type: description: Specifies the type of host checking that was performed. type: - string - 'null' enum: - IsAgentPortAccessible - IsAgentRunning - IsSQLWriterRunning - AreSQLInstancesRunning - CheckServiceLoginsConfig - CheckSQLFCIVIP - CheckSQLDiskSpace x-order: 0 result: description: Specifies the result of host checking performed by agent. type: - string - 'null' enum: - Pass - Fail - Warning x-order: 1 SQLServer: description: Specifies the details of a SQL server. type: object properties: id: description: Specifies the unique identifier of the SQL server host. type: - string - 'null' x-order: 0 resourceInfo: description: Specifies the resource information about the SQL server host. type: - object - 'null' x-order: 1 $ref: '#/components/schemas/AppResource' agentInfo: description: Specifies the information related to agent running on the SQL server. type: - object - 'null' x-order: 2 $ref: '#/components/schemas/AgentInformation_2' error: description: Specifies the error information if any associated with SQL server host. type: - object - 'null' x-order: 3 $ref: '#/components/schemas/Error' isPrimary: description: Indicates whether this is a active node of a FCI cluster or hosts primary replica of a AAG group. type: - boolean - 'null' x-order: 4 instances: description: Specifies the list of all sql instances running inside the current SQL host. type: - array - 'null' items: $ref: '#/components/schemas/SQLServerInstance' x-order: 5 isSelectedByDefault: description: Indicates to the UI whether this server should be selected by default type: - boolean - 'null' x-order: 6 ResourceEndpoint: description: Specifies the details about the resource endpoint. type: object properties: fqdn: description: Specifies the fqdn of this endpoint. type: - string - 'null' x-order: 0 ipv4addr: description: Specifies the ipv4 address of this endpoint. type: - string - 'null' x-order: 1 ipv6addr: description: Specifies the ipv6 address of this endpoint. type: - string - 'null' x-order: 2 subnetIp4addr: description: Specifies the subnet Ip4 address of this endpoint. type: - string - 'null' x-order: 3 preferredAddress: description: Specifies the preferred address to use for connecting. type: - string - 'null' x-order: 4 isPreferredEndpoint: description: Whether to use this endpoint to connect. type: - boolean - 'null' x-order: 5 CassandraConnectionParams: description: Specifies the parameters to connect to a Cassandra seed node and fetch information from its cassandra config file. title: Parameters to connect and query cassandra config file. required: - seedNode - configDirectory - isDseTieredStorage - isDseAuthenticator properties: seedNode: description: Any one seed node of the Cassandra cluster. type: string x-order: 0 configDirectory: description: Directory path containing Cassandra configuration YAML file. type: string x-order: 1 dseConfigurationDirectory: description: Directory from where DSE specific configuration can be read. This should be set only when you are using the DSE distribution of Cassandra. type: - string - 'null' x-order: 2 isDseTieredStorage: description: Set to true if this cluster has DSE tiered storage. type: boolean x-order: 3 isDseAuthenticator: description: Set to true if this cluster has DSE Authenticator. type: boolean x-order: 4 sshPasswordCredentials: description: SSH username + password required for reading configuration file and for scp backup.Either 'sshPasswordCredentials' or 'sshPrivateKeyCredentials' are required. type: - object - 'null' required: - username - password properties: password: description: SSH password. type: string x-order: 0 username: description: SSH username. type: string x-order: 1 x-order: 5 sshPrivateKeyCredentials: description: SSH userID + privateKey required for reading configuration file and for scp backup. type: - object - 'null' required: - userId - privateKey properties: passphrase: description: Passphrase for the private key. type: string x-order: 0 privateKey: description: The private key. type: string x-order: 1 userId: description: userId for PrivateKey credentials. type: string x-order: 2 x-order: 6 SourceAttributeFiltersResponseParams: description: Protection Source attribute filters type: object properties: sourceAttributeFilters: description: Specifies the list of protection source filters. type: array items: $ref: '#/components/schemas/SourceAttributeFilter' x-order: 0 ObjectProtectionStatsSummary: description: Specifies the count and size of protected and unprotected objects for a given environment. type: object title: Object Protection Stats Summary properties: environment: description: Specifies the environment of the object. type: - string - 'null' enum: - kVMware - kHyperV - kAzure - kKVM - kAWS - kAcropolis - kGCP - kPhysical - kPhysicalFiles - kIsilon - kNetapp - kGenericNas - kFlashBlade - kElastifile - kGPFS - kPure - kNimble - kSQL - kOracle - kExchange - kAD - kView - kO365 - kHyperFlex - kKubernetes - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase - kUDA x-go-name: Environment x-order: 0 protectedCount: description: Specifies the count of the protected leaf objects. type: - integer - 'null' format: int64 x-go-name: ProtectedCount x-order: 1 unprotectedCount: description: Specifies the count of the unprotected leaf objects. type: - integer - 'null' format: int64 x-go-name: UnprotectedCount x-order: 2 protectedSizeBytes: description: Specifies the protected logical size in bytes. type: - integer - 'null' format: int64 x-go-name: ProtectedSizeBytes x-order: 3 unprotectedSizeBytes: description: Specifies the unprotected logical size in bytes. type: - integer - 'null' format: int64 x-go-name: UnprotectedSizeBytes x-order: 4 Object: description: Specifies information about an object. title: Object information allOf: - $ref: '#/components/schemas/CommonObjectSummary' - type: object properties: vmwareParams: description: Specifies the parameters which are specific to VMware objects. type: - object - 'null' x-cohesity-discriminator-value: kVMware x-order: 0 $ref: '#/components/schemas/VmwareObjectEntityParams' isilonParams: description: Specifies the parameters for Isilon object. allOf: - $ref: '#/components/schemas/IsilonObjectParams' - {} x-order: 1 netappParams: description: Specifies the parameters for NetApp object. allOf: - $ref: '#/components/schemas/NetappObjectParams' - {} x-order: 2 genericNasParams: description: Specifies the parameters for GenericNas object. allOf: - $ref: '#/components/schemas/CommonNasObjectParams' - {} x-order: 3 flashbladeParams: description: Specifies the parameters for Flashblade object. allOf: - $ref: '#/components/schemas/FlashbladeObjectParams' - {} x-order: 4 elastifileParams: description: Specifies the parameters for Elastifile object. allOf: - $ref: '#/components/schemas/CommonNasObjectParams' - {} x-order: 5 gpfsParams: description: Specifies the parameters for GPFS object. allOf: - $ref: '#/components/schemas/CommonNasObjectParams' - {} x-order: 6 mssqlParams: description: Specifies the parameters for Msssql object. allOf: - $ref: '#/components/schemas/MssqlObjectEntityParams' - {} x-order: 7 oracleParams: description: Specifies the parameters for Oracle object. allOf: - $ref: '#/components/schemas/OracleObjectEntityParams' - {} x-order: 8 VmwareCdpObject: description: Specifies the VMware specific CDP object details. type: object allOf: - $ref: '#/components/schemas/CdpObjectInfo' - type: object properties: ioFilterStatus: description: Specifies the state of CDP IO filter. CDP IO filter is an agent which will be installed on the object for performing continuous backup.
1. 'kNotInstalled' specifies that CDP is enabled on this object but filter is not installed.
2. 'kInstallFilterInProgress' specifies that IO filter installation is triggered and in progress.
3. 'kFilterInstalledIOInactive' specifies that IO filter is installed but IO streaming is disabled due to missing backup or explicitly disabled by the user.
4. 'kIOActivationInProgress' specifies that IO filter is activated to start streaming.
5. 'kIOActive' specifies that filter is attached to the object and started streaming.
6. 'kIODeactivationInProgress' specifies that deactivation has been initiated to stop the IO streaming.
7. 'kUninstallFilterInProgress' specifies that uninstallation of IO filter is in progress. type: - string - 'null' enum: - NotInstalled - InstallFilterInProgress - FilterInstalledIOInactive - FilterInstalled - IOInactive - IOActivationInProgress - IOActive - IODeactivationInProgress - UninstallFilterInProgress - UpgradeFilterInProgress - UpgradeFilterFailed x-order: 0 ioFilterErrorMessage: description: Specifies the error message related to IO filter if there is any. type: - string - 'null' x-order: 1 CdpLocalBackupInfo: description: Specifies the last local backup information for a given CDP object. type: object properties: startTimeInUsecs: description: Specifies the start time of the last local backup taken. type: - integer - 'null' format: int64 x-order: 0 endTimeInUsecs: description: Specifies the end time of the last local backup taken. type: - integer - 'null' format: int64 x-order: 1 AAGInfo: description: Object details for Mssql. type: object properties: objectId: description: Specifies the AAG object Id. type: - integer - 'null' format: int64 x-order: 0 name: description: Specifies the AAG name. type: - string - 'null' x-order: 1 MssqlConnectionParams: description: Specifies the parameters to connect to a SQL node/cluster using given IP or hostname FQDN. type: object allOf: - $ref: '#/components/schemas/MsSQLCommonConnectionParams' User: description: Specifies a user object. type: object title: User properties: name: description: Specifies the name of the user. type: - string - 'null' x-order: 0 sid: description: Specifies the sid of the user. type: - string - 'null' x-order: 1 domain: description: Specifies the domain of the user. type: - string - 'null' x-order: 2 OracleObjectEntityParams: description: Object details for Oracle. type: object properties: databaseEntityInfo: description: Specifies the database entity information about the type of Oracle database. type: - object - 'null' x-order: 0 $ref: '#/components/schemas/DatabaseEntityInfo' hostInfo: description: Specifies the host information for the Oracle object. type: - object - 'null' x-order: 1 $ref: '#/components/schemas/HostInformation' HostInformation: description: Specifies the host information for a objects. This is mainly populated in case of App objects where app object is hosted by another object such as VM or physical server. type: object properties: id: description: Specifies the id of the host object. type: - string - 'null' x-order: 0 name: description: Specifies the name of the host object. type: - string - 'null' x-order: 1 environment: description: Specifies the environment of the object. type: - string - 'null' enum: - kVMware - kHyperV - kAzure - kKVM - kAWS - kAcropolis - kGCP - kPhysical - kPhysicalFiles - kIsilon - kNetapp - kGenericNas - kFlashBlade - kElastifile - kGPFS - kPure - kNimble - kSQL - kOracle - kExchange - kAD - kView - kO365 - kHyperFlex - kKubernetes - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase - kUDA x-order: 2 Tenant: description: Specifies a tenant object. type: object title: Tenant properties: id: description: Specifies the id of the tenant. type: - string - 'null' x-order: 0 name: description: Specifies the name of the tenant. type: - string - 'null' x-order: 1 CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0: description: Specifies the parameters which are common between all Protection Source registrations. type: object properties: id: description: Source Registration ID. This can be used to retrieve, edit or delete the source registration. type: - integer - 'null' format: int64 x-order: 0 readOnly: true sourceId: description: ID of top level source object discovered after the registration. type: - integer - 'null' format: int64 x-order: 1 readOnly: true sourceInfo: description: Specifies detailed info about the source. type: - object - 'null' x-order: 2 $ref: '#/components/schemas/Object' environment: description: Specifies the environment type of the Protection Source. type: - string - 'null' enum: - kVMware - kHyperV - kAcropolis - kKVM - kAWS - kGCP - kAzure - kPhysical - kPure - kNimble - kNetapp - kGenericNas - kIsilon - kFlashBlade - kGPFS - kElastifile - kO365 - kHyperFlex - kKubernetes - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase - kUDA x-order: 3 connectionId: description: Specifies the id of the connection from where this source is reachable. This should only be set for a source being registered by a tenant user. type: - integer - 'null' format: int64 x-order: 4 x-cohesity-discriminator-details: propertyName: environment x-discriminator: mapping: kVMware: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0VmwareSourceRegistrationParamsWrapper' kPhysical: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0PhysicalSourceRegistrationParamsWrapper' kGenericNas: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0GenericNasRegistrationParamsWrapper' kIsilon: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0IsilonRegistrationParamsWrapper' kNetapp: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0NetappRegistrationParamsWrapper' kElastifile: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0ElastifileRegistrationParamsWrapper' kFlashBlade: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0FlashbladeRegistrationParamsWrapper' kGPFS: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0GpfsRegistrationParamsWrapper' kCassandra: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0CassandraSourceRegistrationParamsWrapper' kMongoDB: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0MongoDBSourceRegistrationParamsWrapper' kCouchbase: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0CouchbaseSourceRegistrationParamsWrapper' kHdfs: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0HdfsSourceRegistrationParamsWrapper' kHBase: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0HbaseSourceRegistrationParamsWrapper' kHive: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0HiveSourceRegistrationParamsWrapper' kUDA: '#/definitions/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0UdaSourceRegistrationParamsWrapper' propertyName: environment CdpObjectInfo: description: Specifies the CDP related information for a given object. This field will only be populated when protection group is configured with policy having CDP retention settings. type: object properties: cdpEnabled: description: Specifies whether CDP is currently active or not. CDP might have been active on this object before, but it might not be anymore. type: - boolean - 'null' x-order: 0 lastRunInfo: description: Specifies the details about last continious backup taken for this object. type: - object - 'null' x-order: 1 $ref: '#/components/schemas/CdpObjectLastRunInfo' protectionGroupId: description: Specifies the protection group id to which this CDP object belongs. type: - string - 'null' x-order: 2 readOnly: true SQLServerInstance: description: Specifies the details of a SQL server. type: object properties: id: description: Specifies the unique id of the SQL server instance. type: - string - 'null' x-order: 0 name: description: Specifies the name of the SQL server instance. type: - string - 'null' x-order: 1 isOnline: description: Specifies the wehther the SQL server instance is online or not. type: - string - 'null' x-order: 2 endpoints: description: Specifies the information about endpoint associated with this SQL server instance. type: - array - 'null' items: $ref: '#/components/schemas/ResourceEndpoint' x-order: 3 isPartofFCI: description: Specifies whether this SQL server instance is a part of Failover cluster or not. type: - boolean - 'null' x-order: 4 SourceRegistrations: description: Protection Source Registrations. type: object properties: registrations: description: Specifies the list of Protection Source Registrations. type: - array - 'null' items: x-cohesity-discriminator-ref: CommonSourceRegistrationReponseParams $ref: '#/components/schemas/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0' x-order: 0 MsSQLCommonConnectionParams: description: Specifies the common parameters to connect to a SQL node/cluster type: object required: - hostIdentifier properties: hostIdentifier: description: Specifies the unique identifier to locate the SQL node or cluster. The host identifier can be IP address or FQDN. type: string x-order: 0 HadoopConnectionParams: description: Specifies the parameters to connect to a seed node and fetch information from its config file. title: Parameters to connect and query hdfs config file. required: - host - configurationDirectory properties: host: description: IP or hostname of any host from which the configuration file can be read. type: string x-order: 0 configurationDirectory: description: The directory containing the application specific config file. . type: string x-order: 1 sshPasswordCredentials: description: SSH username + password required for reading configuration file and for scp backup.Either 'sshPasswordCredential' or 'sshPrivateKeyCredential' are required. type: - object - 'null' required: - username - password properties: password: description: SSH password. type: string x-order: 0 username: description: SSH username. type: string x-order: 1 x-order: 2 sshPrivateKeyCredentials: description: SSH userID + privateKey required for reading configuration file and for scp backup. type: - object - 'null' required: - userId - privateKey properties: passphrase: description: Passphrase for the private key. type: string x-order: 0 privateKey: description: The private key. type: string x-order: 1 userId: description: userId for PrivateKey credentials. type: string x-order: 2 x-order: 3 MssqlObjectEntityParams: description: Object details for Mssql. type: object properties: hostInfo: description: Specifies the host information for the SQL object. Includes details of Host object such as VM or Physical server. type: - object - 'null' x-order: 0 $ref: '#/components/schemas/HostInformation' aagInfo: description: Specifies the Always on Avalibility (AAG) information if associated with the SQL Object. type: - object - 'null' x-order: 1 $ref: '#/components/schemas/AAGInfo' FlashbladeObjectParams: description: Specifies the common parameters for Flashblade objects. type: object properties: supportedNasMountProtocols: description: Specifies a list of NAS mount protocols supported by this object. type: - array - 'null' items: type: string enum: - kNfs - kCifs2 - kHttp x-order: 0 HBaseAdditionalParams: description: Additional params for HBase protection source. type: object title: HBAse Additional Params. properties: zookeeperQuorum: description: The 'Zookeeper Quorum' for this HBase. type: - array - 'null' items: type: string x-order: 0 readOnly: true dataRootDirectory: description: The 'Data root directory' for this HBase. type: - string - 'null' x-order: 1 readOnly: true authType: description: Authentication type. type: - string - 'null' enum: - KERBEROS - NONE x-order: 2 readOnly: true CommonObjectSummary: description: Specifies an Common summary properties for an object. type: object title: Common Object Entity Summary. allOf: - $ref: '#/components/schemas/ObjectSummary' - type: object properties: protectionStats: description: Specifies the count and size of protected and unprotected objects for the size. type: - array - 'null' items: $ref: '#/components/schemas/ObjectProtectionStatsSummary' x-order: 0 permissions: description: Specifies the list of users, groups and tenants that have permissions for this object. type: object x-order: 1 $ref: '#/components/schemas/PermissionInfo' x-cohesity-discriminator-details: propertyName: environment OrgVDCNetwork: description: Specifies a VDC Organization Network. type: object required: - vcdUuid - name properties: vcdUuid: description: Specifies the UUID of network associated with the Virtual Cloud director. type: - string - 'null' x-order: 0 name: description: Specifies the name of the catalog. type: - string - 'null' x-order: 1 vCenterUuid: description: Specifies the UUID of network associated with the Vcenter. type: - string - 'null' x-order: 2 readOnly: true MssqlConnectionResponseParams: description: Specifies the response parameters after connecting to a SQL node/cluster using given IP or hostname FQDN. type: object allOf: - $ref: '#/components/schemas/MsSQLCommonConnectionParams' - type: object properties: error: description: Specifies the error information if any associated with the app topology response. type: - object - 'null' x-order: 0 $ref: '#/components/schemas/Error' skipConnectionDiscovery: description: Specifies whether to skip the discovery phase of all SQL servers, AAG groups etc during registration process. type: - boolean - 'null' x-order: 1 servers: description: Specifies the list of SQL servers. If SQL server is a part of avalibility group then it will be returned in aagServers field. This will include the list of all standalone SQL servers and servers belonging to any FCI enviournment. type: - array - 'null' items: $ref: '#/components/schemas/SQLServer' x-order: 2 fciClusters: description: Specifies the list of FCI (Failover Cluster Instaces) Clusters. This will contain the list of all failover pools under a windows cluster. FCI clusters which are part of AAG, will be returned seperatly under aagServers field. type: - array - 'null' items: $ref: '#/components/schemas/FCICluster' x-order: 3 aagGroups: description: Specifies the list of AAG (Always on Avalibility) groups. type: - array - 'null' items: $ref: '#/components/schemas/AAGGroup' x-order: 4 FCICluster: description: Specifies the details of a Failover Cluster Instance. type: object properties: id: description: Specifies the unique identifier of the FCI. type: - string - 'null' x-order: 0 name: description: Specifies the name of the FCI. type: - string - 'null' x-order: 1 error: description: Specifies the error information if any associated with this FCI cluster. type: - object - 'null' x-order: 2 $ref: '#/components/schemas/Error' resourceInfo: description: Specifies the resource information about the FCI. type: - object - 'null' x-order: 3 $ref: '#/components/schemas/AppResource' servers: description: 'Specifies the list of SQL servers which belongs to the given FCI. ' type: - array - 'null' items: $ref: '#/components/schemas/SQLServer' x-order: 4 isSelectedByDefault: description: Indicates to the UI whether this FCI cluster should be selected by default type: - boolean - 'null' x-order: 5 Source: description: Specifies the Protection Source. title: Protection Source. allOf: - $ref: '#/components/schemas/Object' - type: object properties: lastRefreshedTime: description: Time at which the data about this protection source was last refreshed. type: - integer - 'null' format: int64 x-order: 0 registrationId: description: Id of the registration as part of which this source was discovered. type: - integer - 'null' format: int64 x-order: 1 HdfsAdditionalParams: description: Additional params for Hdfs protection source. type: object title: Hdfs Additional Params. properties: namenodeAddress: description: The HDFS Namenode IP or hostname. type: string x-order: 0 readOnly: true webhdfsPort: description: The HDFS WebHDFS port. type: integer format: int32 x-order: 1 readOnly: true authType: description: Authentication type. type: - string - 'null' enum: - KERBEROS - NONE x-order: 2 readOnly: true ObjectIdentifier: description: Specifies the basic info to identify an object. title: Object Identifier. properties: id: description: Specifies object id. type: - integer - 'null' format: int64 x-order: 0 name: description: Specifies the name of the object. type: - string - 'null' x-order: 1 sourceId: description: Specifies registered source id to which object belongs. type: - integer - 'null' format: int64 x-order: 2 sourceName: description: Specifies registered source name to which object belongs. type: - string - 'null' x-order: 3 environment: description: Specifies the environment of the object. type: - string - 'null' enum: - kVMware - kHyperV - kAzure - kKVM - kAWS - kAcropolis - kGCP - kPhysical - kPhysicalFiles - kIsilon - kNetapp - kGenericNas - kFlashBlade - kElastifile - kGPFS - kPure - kNimble - kSQL - kOracle - kExchange - kAD - kView - kO365 - kHyperFlex - kKubernetes - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase - kUDA x-order: 4 CassandraSecurityInfo_2: description: Cassandra security related info. type: object title: Cassandra security info. properties: cassandraAuthorizer: description: Cassandra Authenticator/Authorizer. type: - string - 'null' x-order: 0 cassandraAuthRequired: description: Is Cassandra authentication required ? type: - boolean - 'null' x-order: 1 cassandraAuthType: description: Cassandra Authentication type. type: - string - 'null' enum: - PASSWORD - KERBEROS - LDAP x-order: 2 dseAuthorization: description: Is DSE Authorization enabled for this cluster ? type: - boolean - 'null' x-order: 3 clientEncryption: description: Is Client Encryption enabled for this cluster ? type: - boolean - 'null' x-order: 4 serverInternodeEncryptionType: description: '''Server internal node Encryption'' type.' type: - string - 'null' x-order: 5 serverEncryptionReqClientAuth: description: Is 'Server encryption request client authentication' enabled for this cluster ? type: - boolean - 'null' x-order: 6 Error: description: Specifies the error object with error code and a message. type: object title: Error. properties: errorCode: description: Specifies the error code. type: - string - 'null' x-order: 0 message: description: Specifies the error message. type: - string - 'null' x-order: 1 CdpObjectLastRunInfo: description: Specifies the last backup information for a given CDP object. type: object properties: localBackupInfo: description: Specifies the last backup information for a given CDP object. type: - object - 'null' x-order: 0 $ref: '#/components/schemas/CdpLocalBackupInfo' VmwareConnectionParams: description: Specifies the parameters to connect to a seed node and fetch information from its config file. type: object title: Parameters to connect and query VMware config file. required: - type properties: type: description: Specifies the VMware Source type. type: - string - 'null' enum: - kVCenter - kStandaloneHost - kvCloudDirector x-order: 0 vcdParams: description: Specifies the parameters to register a VCD. type: - object - 'null' x-order: 1 $ref: '#/components/schemas/VcdConnectionParams' IsilonObjectParams: description: Specifies the common parameters for Isilon objects. type: object properties: supportedNasMountProtocols: description: Specifies a list of NAS mount protocols supported by this object. type: - array - 'null' items: type: string enum: - kNfs - kSmb x-order: 0 AgentInformation_2: description: Specifies the agent details. type: object properties: connectionStatus: description: Specifies the status of agent connection. type: - string - 'null' enum: - Unknown - Healthy - Unregistered - Unreachable - Unhealthy - Error x-order: 0 supportStatus: description: Specifies the whether agent version is compatible with cluster version ro use various features. type: - string - 'null' enum: - Supported - Upgrade - Unsupported x-order: 1 agentSwVersion: description: Specifies the software version of the agent type: - string - 'null' x-order: 2 lastFetchedTimeInUsecs: description: Specifies the time in usecs when the last agent info was fetched. type: - integer - 'null' format: int64 x-order: 3 hostSettingChecks: description: Specifies the list of host checks and its results. type: - array - 'null' items: $ref: '#/components/schemas/HostSettingCheck' x-order: 4 SourceAttributeFilter: description: Specifies a pair of source filter attribute and its possible values. type: object properties: filterAttribute: description: Specifies the filter attribute for the source. type: - string - 'null' x-order: 0 attributeValues: description: Specifies the list of attribute values for above filter. type: - array - 'null' items: type: string x-order: 1 DatabaseEntityInfo: description: Object details about Oracle database entity info. type: object properties: containerDatabaseInfo: description: Specifies the information about container database. type: - object - 'null' x-order: 0 $ref: '#/components/schemas/ContainerDatabaseInfo' VcdConnectionParams: description: Specifies the parameters to connect to a seed node and fetch information from its config file. title: Parameters to connect and query VMware config file. allOf: - type: object required: - host properties: host: description: IP or hostname of the source. type: - string - 'null' x-order: 0 - $ref: '#/components/schemas/Credentials_2' HiveAdditionalParams: description: Additional params for Hive protection source. type: object title: Hive Additional Params. properties: metastoreAddress: description: The MetastoreAddress for this Hive. type: string x-order: 0 readOnly: true metastorePort: description: The MetastorePort for this Hive. type: integer format: int32 x-order: 1 readOnly: true authType: description: Authentication type. type: - string - 'null' enum: - KERBEROS - NONE x-order: 2 readOnly: true responses: ListProtectedObjectsResponse: description: Success content: application/json: schema: description: 'Specifies a list of Protected Objects in a registered Protection Source and the protection stats.' type: array items: $ref: '#/components/schemas/ProtectedVmInfo' UpgradePhysicalAgentsResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/UpgradePhysicalAgentsMessage' ListProtectionSourcesResponse: description: Success content: application/json: schema: description: 'List of Protection Sources and Object subtrees matching the specified filter criteria.' type: array title: Array of Sources and Subtrees. items: $ref: '#/components/schemas/ProtectionSourceNode' ListExchangeDagHostsResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/ExchangeDagHostsResponse' ListApplicationServersResponse: description: Success content: application/json: schema: description: 'Specifies a list of Application Servers found in a Protection Source tree given the root node id of the Protection Source tree and filtered by the application type like ''kSQL'', or ''kExchange''.' type: array title: Array of Application Servers. items: $ref: '#/components/schemas/RegisteredApplicationServer' ListProtectionSourcesRegistrationInfoResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/GetRegistrationInfoResponse' RegisterProtectionSourceResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/ProtectionSource' ListVirtualMachinesResponse: description: Success content: application/json: schema: type: array title: Array of Protection Source VM Leaf Nodes. items: $ref: '#/components/schemas/ProtectionSource' GetProtectionSourcesObjectsResponse: description: Success content: application/json: schema: type: array title: Array of Protection Source Objects. items: $ref: '#/components/schemas/ProtectionSource' UpdateApplicationServersResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/ProtectionSource' NoContentResponse: description: No Content DownloadPhysicalAgentResponse: description: Success content: application/json: schema: type: array title: Specifies the content of the physical agent binary. items: type: integer format: uint8 ListDataStoreInformationResponse: description: Success content: application/json: schema: description: 'Specifies a list of datastores for a given virtual machine in VMware environment.' type: array items: $ref: '#/components/schemas/ProtectionSource' UpdatedProtectionSourceResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/ProtectionSourceNode' DownloadCftFileResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/DownloadCftResponse' GetProtectionSourcesObjectByIdResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/ProtectionSource' ListSqlAagHostsAndDatabasesResponse: description: 'List SQL AAG hosts and databases response. Success' content: application/json: schema: type: array items: $ref: '#/components/schemas/SqlAagHostAndDatabases' RegisterApplicationServersResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/ProtectionSource' UnregisterApplicationServersResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/ProtectionSource' Error: description: Error content: application/json: schema: $ref: '#/components/schemas/RequestError' ListProtectionSourcesRootNodesResponse: description: Success content: application/json: schema: description: 'Specifies the array of root nodes of Protection Source trees with registration information.' type: array title: Array of Root Nodes. items: $ref: '#/components/schemas/ProtectionSourceNode' RunDiagnosticsResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/RunDiagnosticsMessage' SourceAttributeFiltersResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/SourceAttributeFiltersResponseParams' SourceRegistrationResponse: description: Success content: application/json: schema: x-cohesity-discriminator-ref: CommonSourceRegistrationReponseParams $ref: '#/components/schemas/CommonSourceRegistrationReponseParams4607ba17-2103-4171-897b-727e2867f7b0' SourceResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/Source' ErrorResponse: description: Error content: application/json: schema: $ref: '#/components/schemas/Error' SourceRegistrationsResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/SourceRegistrations' GetVdcByIdResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/VdcObject' SourcesResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/Sources' SourceConnectionResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/SourceConnectionResponseParams' securitySchemes: APIKeyHeader: in: header name: apiKey type: apiKey x-refined-from: - cohesity-cluster-v1-openapi-original.yml - cohesity-cluster-v2-openapi-original.yml