openapi: 3.2.0 info: description: 'This API list provides operations for interfacing with the Cohesity Cluster.' title: Cohesity REST Principals API version: '1.0' servers: - url: https:///irisservices/api/v1 tags: - name: Principals paths: /public/principals/protectionSources: get: description: 'From the passed in list principals (specified by SIDs), return the list of Protection Sources objects and View names that each principal has permission to access.' tags: - Principals summary: Returns the Protection Sources objects and View names that the principals have… operationId: ListSourcesForPrincipals parameters: - x-go-name: Sids description: 'Specifies a list of security identifiers (SIDs) that specify user or group principals.' name: sids in: query schema: type: array items: type: string responses: '200': $ref: '#/components/responses/ListSourcesForPrincipalsResponse' default: $ref: '#/components/responses/Error' put: description: 'Specify the security identifier (SID) of the principal to grant access permissions for.' tags: - Principals summary: Set the Protection Sources and Views that the specified principal has… operationId: UpdateSourcesForPrincipals responses: '204': $ref: '#/components/responses/NoContentResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSourcesForPrincipalsParams' description: 'Request to set access permissions to Protection Sources and Views for a principal.' required: true /public/principals/searchPrincipals: get: description: 'Optionally, limit the search results by specifying security identifiers (SIDs), an object class (user or group) or a substring. You can specify SIDs or a substring but not both.' tags: - Principals summary: List the user and group principals that match the filter criteria specified… operationId: SearchPrincipals parameters: - x-go-name: Domain description: 'Specifies the domain name of the principals to search. If specified the principals in that domain are searched. Domain could be an Active Directory domain joined by the Cluster or any one of the trusted domains of the Active Directory domain or the LOCAL domain. If not specified, all the domains are searched.' name: domain in: query schema: type: string - x-go-name: ObjectClass description: 'Optionally filter by a principal object class such as ''kGroup'' or ''kUser''. If ''kGroup'' is specified, only group principals are returned. If ''kUser'' is specified, only user principals are returned. If not specified, both group and user principals are returned. ''kUser'' specifies a user object class. ''kGroup'' specifies a group object class. ''kComputer'' specifies a computer object class. ''kWellKnownPrincipal'' specifies a well known principal.' name: objectClass in: query schema: type: string enum: - kUser - kGroup - kComputer - kWellKnownPrincipal - x-go-name: Search description: 'Optionally filter by matching a substring. Only principals in the with a name or sAMAccountName that matches part or all of the specified substring are returned. If specified, a ''sids'' parameter should not be specified.' name: search in: query schema: type: string - x-go-name: Sids description: 'Optionally filter by a list of security identifiers (SIDs) found in the specified domain. Only principals matching the specified SIDs are returned. If specified, a ''search'' parameter should not be specified.' name: sids in: query schema: type: array items: type: string - x-go-name: IncludeComputers description: Specifies if Computer/GMSA accounts need to be included in this search. name: includeComputers in: query schema: type: boolean responses: '200': $ref: '#/components/responses/SearchPrincipalsResponse' default: $ref: '#/components/responses/Error' /public/sessionUser: get: tags: - Principals summary: Get the information of the logged in user operationId: GetSessionUser responses: '200': $ref: '#/components/responses/GetSessionUserResponse' default: $ref: '#/components/responses/Error' /public/users: get: description: 'If no parameters are specified, all users currently on the Cohesity Cluster are returned. Specifying parameters filters the results that are returned.' tags: - Principals summary: List the users on the Cohesity Cluster that match the filter criteria specified… operationId: GetUsers parameters: - x-go-name: TenantIds description: 'TenantIds contains ids of the tenants for which objects are to be returned.' name: tenantIds in: query schema: type: array items: type: string - x-go-name: AllUnderHierarchy description: 'AllUnderHierarchy specifies if objects of all the tenants under the hierarchy of the logged in user''s organization should be returned.' name: allUnderHierarchy in: query schema: type: boolean - x-go-name: Usernames description: 'Optionally specify a list of usernames to filter by. All users containing username will be returned.' name: usernames in: query schema: type: array items: type: string - x-go-name: EmailAddresses description: Optionally specify a list of email addresses to filter by. name: emailAddresses in: query schema: type: array items: type: string - x-go-name: Domain description: 'Optionally specify a domain to filter by. If no domain is specified, all users on the Cohesity Cluster are searched. If a domain is specified, only users on the Cohesity Cluster associated with that domain are searched.' name: domain in: query schema: type: string - x-go-name: PartialMatch description: 'Optionally specify whether to enable partial match. If set, all users with name containing Usernames will be returned. If set to false, only users with exact the same name as Usernames will be returned. By default this parameter is set to true.' name: partialMatch in: query schema: type: boolean responses: '200': $ref: '#/components/responses/GetUsersResponse' default: $ref: '#/components/responses/Error' put: description: Returns the user that was updated on the Cohesity Cluster. tags: - Principals summary: Update an existing user on the Cohesity Cluster. operationId: UpdateUser responses: '200': $ref: '#/components/responses/UpdateUserResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/User' description: Request to update an existing user. post: description: 'If an Active Directory domain is specified, a new user is added to the Cohesity Cluster for the specified Active Directory user principal. If the LOCAL domain is specified, a new user is created directly in the default LOCAL domain on the Cohesity Cluster. Returns the created or added user.' tags: - Principals summary: Create or add a new user to the Cohesity Cluster operationId: CreateUser responses: '201': $ref: '#/components/responses/CreateUserResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/UserParameters' description: Request to add or create a new user. delete: description: 'Only users from the same domain can be deleted by a single request. If the Cohesity user was created for an Active Directory user, the referenced principal user on the Active Directory domain is NOT deleted. Only the user on the Cohesity Cluster is deleted. Returns Success if the specified users are deleted.' tags: - Principals summary: Delete one or more users on the Cohesity Cluster operationId: DeleteUsers responses: '204': $ref: '#/components/responses/NoContentResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/UserDeleteParameters' description: Request to delete one or more users on the Cohesity Cluster. /public/users/privileges: get: tags: - Principals summary: List the privileges of the session user operationId: GetUserPrivileges responses: '200': $ref: '#/components/responses/GetUserPrivilegesResponse' default: $ref: '#/components/responses/Error' /public/users/s3SecretKey: post: description: Returns the new key that was generated. tags: - Principals summary: Reset the S3 secret access key for the specified user on the Cohesity Cluster operationId: ResetS3SecretKey responses: '200': $ref: '#/components/responses/ResetS3SecretKeyResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/ResetS3SecretKeyParameters' description: Request to reset the S3 secret access key for the specified Cohesity user. /public/users/{sid}/apiKeys: get: tags: - Principals summary: Fetch API keys for user operationId: GetUserApiKeys parameters: - x-go-name: Ids description: Specifies a list of API key ids. name: ids in: query schema: type: array items: type: string - x-go-name: Sid description: Specifies the user sid. name: sid in: path required: true schema: type: string responses: '200': $ref: '#/components/responses/GetApiKeysResponse' default: $ref: '#/components/responses/Error' post: tags: - Principals summary: Create an API key for user operationId: CreateUserApiKey parameters: - x-go-name: Sid description: Specifies the user sid. name: sid in: path required: true schema: type: string responses: '201': $ref: '#/components/responses/CreateApiKeyResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateApiKeyParams' description: Request to create an API key. required: true /public/users/{sid}/apiKeys/{id}: get: tags: - Principals summary: Fetch an API key for user by its id operationId: GetUserApiKeyById parameters: - x-go-name: Sid description: Specifies the user sid. name: sid in: path required: true schema: type: string - x-go-name: Id description: Specifies the API key id. name: id in: path required: true schema: type: string responses: '200': $ref: '#/components/responses/GetApiKeyByIdResponse' default: $ref: '#/components/responses/Error' put: tags: - Principals summary: Update an API key operationId: UpdateUserApiKey parameters: - x-go-name: Sid description: Specifies the user sid. name: sid in: path required: true schema: type: string - x-go-name: Id description: Specifies the API key id. name: id in: path required: true schema: type: string responses: '200': $ref: '#/components/responses/CreateApiKeyResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateApiKeyParams' description: Request to update an API key. required: true delete: tags: - Principals summary: Delete an API key for user operationId: DeleteUserApiKey parameters: - x-go-name: Sid description: Specifies the user sid. name: sid in: path required: true schema: type: string - x-go-name: Id description: Specifies the API key id. name: id in: path required: true schema: type: string responses: '204': $ref: '#/components/responses/NoContentResponse' default: $ref: '#/components/responses/Error' /public/users/{sid}/apiKeys/{id}/rotate: post: tags: - Principals summary: Fetch an API key for user by its id operationId: RotateUserApiKey parameters: - x-go-name: Sid description: Specifies the user sid. name: sid in: path required: true schema: type: string - x-go-name: Id description: Specifies the API key id. name: id in: path required: true schema: type: string responses: '200': $ref: '#/components/responses/RotateUserApiKeyResponse' default: $ref: '#/components/responses/Error' /public/usersApiKeys: get: tags: - Principals summary: Fetch API keys across all users operationId: GetAllUserApiKeys parameters: - x-go-name: UserSids description: Specifies a list of user sids. name: userSids in: query schema: type: array items: type: string responses: '200': $ref: '#/components/responses/GetApiKeysResponse' default: $ref: '#/components/responses/Error' components: schemas: VlanParameters: description: Specifies VLAN parameters for the restore operation. type: object title: VLAN Parameters. properties: disableVlan: description: 'Specifies whether to use the VIPs even when VLANs are configured on the Cluster. If configured, VLAN IP addresses are used by default. If VLANs are not configured, this flag is ignored. Set this flag to true to force using the partition VIPs when VLANs are configured on the Cluster.' type: - boolean - 'null' x-go-name: DisableVlan interfaceName: description: 'Specifies the physical interface group name to use for mounting Cohesity''s view on the remote host. If specified, Cohesity hostname or the IP address on this VLAN is used.' type: - string - 'null' x-go-name: InterfaceName vlan: description: 'Specifies the VLAN to use for mounting Cohesity''s view on the remote host. If specified, Cohesity hostname or the IP address on this VLAN is used.' type: - integer - 'null' format: int32 x-go-name: Vlan x-go-package: cohesity/iris/server/data/public AzureProtectionSource: description: Specifies a Protection Source in Azure environment. type: object title: Azure Protection Source. properties: applicationId: description: Specifies Application Id of the active directory of Azure account. type: - string - 'null' x-go-name: ApplicationId applicationKey: description: Specifies Application key of the active directory of Azure account. type: - string - 'null' x-go-name: ApplicationKey azureType: description: 'Specifies the entity type such as ''kSubscription'' if the environment is kAzure. Specifies the type of an Azure source entity. ''kSubscription'' indicates a billing unit within Azure account. ''kResourceGroup'' indicates a container that holds related resources. ''kVirtualMachine'' indicates a Virtual Machine in Azure environment. ''kStorageAccount'' represents a collection of storage containers. ''kStorageKey'' indicates a key required to access the storage account. ''kStorageContainer'' represents a storage container within a storage account. ''kStorageBlob'' represents a storage blog within a storage container. ''kStorageResourceGroup'' indicates a container that holds related storage resources. ''kNetworkSecurityGroup'' represents a network security group. ''kVirtualNetwork'' represents a virtual network. ''kNetworkResourceGroup'' indicates a container that holds related network resources. ''kSubnet'' represents a subnet within the virtual network. ''kComputeOptions'' indicates the number of CPU cores and memory size available for a type of a Virtual Machine.' type: - string - 'null' enum: - kSubscription - kResourceGroup - kVirtualMachine - kStorageAccount - kStorageKey - kStorageContainer - kStorageBlob - kStorageResourceGroup - kNetworkSecurityGroup - kVirtualNetwork - kNetworkResourceGroup - kSubnet - kComputeOptions x-go-name: AzureType hostType: description: 'Specifies the OS type of the Protection Source of type ''kVirtualMachine'' such as ''kWindows'' or ''kLinux''. overrideDescription: true ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: HostType ipAddresses: description: Specifies a list of IP addresses for entities of type 'kVirtualMachine'. type: - array - 'null' items: type: string x-go-name: IpAddresses isManagedVm: description: 'Specifies whether VM is managed or not for entities of type ''kVirtualMachine''.' type: - boolean - 'null' x-go-name: IsManagedVm location: description: Specifies the physical location of the resource group. type: - string - 'null' x-go-name: Location memoryMbytes: description: 'Specifies the amount of memory in MegaBytes of the Azure resource of type ''kComputeOptions''.' type: - integer - 'null' format: int64 x-go-name: MemoryMbytes name: description: 'Specifies the name of the Object set by the Cloud Provider. If the provider did not set a name for the object, this field is not set.' type: - string - 'null' x-go-name: Name numCores: description: 'Specifies the number of CPU cores of the Azure resource of type ''kComputeOptions''.' type: - integer - 'null' format: int32 x-go-name: NumCores physicalSourceId: description: 'Specifies the Protection Source id of the registered Physical Host. If the cloud entity is protected using a Physical Agent, it must be registered as a physical host.' type: - integer - 'null' format: int64 x-go-name: PhysicalSourceId resourceId: description: Specifies the unique Id of the resource given by the cloud provider. type: - string - 'null' x-go-name: ResourceId restoreTaskId: description: 'Specifies the id of the "convert and deploy" restore task that created the entity in the cloud. It is required to support the DR-to-cloud usecase where we replicate an on-prem entity to a cluster running in cloud, bring it up using "convert and deploy" mechanism, protect it using a cloud job that uses physical adapter, and convert it back to the on-prem format before replication. Before replicating, we need to update the backup task state of the backed up entity using the on-prem entity and on-prem entity''s parent. The id is used to lookup the restore entity that contains details about the on-prem entity. It is set at the time of refreshing the cloud entity hierarchy if all the following conditions are met: Name of the current entity matches with name of any cloud entity deployed using the "convert and deploy" restore task. Restore entity associated with the above matched cloud entity has ''failed_over'' flag set to true in its cloud extension.' type: - integer - 'null' format: int64 x-go-name: RestoreTaskId subscriptionId: description: 'Specifies Subscription id inside a customer''s Azure account. It represents sub-section within the Azure account where a customer allows us to create VMs, storage account etc.' type: - string - 'null' x-go-name: SubscriptionId subscriptionType: description: 'Specifies the subscription type of Azure such as ''kAzureCommercial'' or ''kAzureGovCloud''. Specifies the subscription type of an Azure source entity. ''kAzureCommercial'' indicates a standard Azure subscription. ''kAzureGovCloud'' indicates a govt Azure subscription.' type: - string - 'null' enum: - kAzureCommercial - kAzureGovCloud x-go-name: SubscriptionType tenantId: description: Specifies Tenant Id of the active directory of Azure account. type: - string - 'null' x-go-name: TenantId type: description: 'Specifies the type of an Azure Protection Source Object such as ''kStorageContainer'', ''kVirtualMachine'', ''kVirtualNetwork'', etc. Specifies the type of an Azure source entity. ''kSubscription'' indicates a billing unit within Azure account. ''kResourceGroup'' indicates a container that holds related resources. ''kVirtualMachine'' indicates a Virtual Machine in Azure environment. ''kStorageAccount'' represents a collection of storage containers. ''kStorageKey'' indicates a key required to access the storage account. ''kStorageContainer'' represents a storage container within a storage account. ''kStorageBlob'' represents a storage blog within a storage container. ''kStorageResourceGroup'' indicates a container that holds related storage resources. ''kNetworkSecurityGroup'' represents a network security group. ''kVirtualNetwork'' represents a virtual network. ''kNetworkResourceGroup'' indicates a container that holds related network resources. ''kSubnet'' represents a subnet within the virtual network. ''kComputeOptions'' indicates the number of CPU cores and memory size available for a type of a Virtual Machine.' type: - string - 'null' enum: - kSubscription - kResourceGroup - kVirtualMachine - kStorageAccount - kStorageKey - kStorageContainer - kStorageBlob - kStorageResourceGroup - kNetworkSecurityGroup - kVirtualNetwork - kNetworkResourceGroup - kSubnet - kComputeOptions x-go-name: Type x-go-package: cohesity/iris/server/data/public PhysicalProtectionSource: description: Specifies a Protection Source in a Physical environment. type: object title: Physical Protection Source. properties: agents: description: 'Array of Agents on the Physical Protection Source. Specifiles the agents running on the Physical Protection Source and the status information.' type: - array - 'null' items: $ref: '#/components/schemas/AgentInformation' x-go-name: Agents hostName: description: Specifies the hostname. type: - string - 'null' x-go-name: HostName hostType: description: 'Specifies the environment type for the host. ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: HostType id: description: 'Specifies a unique id of a Physical Protection Source. The id is unique across Cohesity Clusters.' allOf: - $ref: '#/components/schemas/UniversalId' memorySizeBytes: description: Specifies the total memory on the host in bytes. type: - integer - 'null' format: int64 x-go-name: MemorySizeBytes name: description: Specifies a human readable name of the Protection Source. type: - string - 'null' x-go-name: Name networkingInfo: description: 'Cached networking info. This establishes physical-->agent linkage for the Cluster case.' $ref: '#/components/schemas/NetworkingInformation' numProcessors: description: Specifies the number of processors on the host. type: - integer - 'null' format: int64 x-go-name: NumProcessors osName: description: Specifies a human readable name of the OS of the Protection Source. type: - string - 'null' x-go-name: OsName type: description: 'Specifies the type of managed Object in a Physical Protection Source. ''kGroup'' indicates the EH container. ''kHost'' indicates a single physical server. ''kWindowsCluster'' indicates a Microsoft Windows cluster. ''kOracleRACCluster'' indicates an Oracle Real Application Cluster(RAC). ''kOracleAPCluster'' indicates an Oracle Active-Passive Cluster.' type: - string - 'null' enum: - kGroup - kHost - kWindowsCluster - kOracleRACCluster - kOracleAPCluster x-go-name: Type vcsVersion: description: Specifies cluster version for VCS host. type: - string - 'null' x-go-name: VcsVersion volumes: description: 'Array of Physical Volumes. Specifies the volumes available on the physical host. These fields are populated only for the kPhysicalHost type.' type: - array - 'null' items: $ref: '#/components/schemas/PhysicalVolume' x-go-name: Volumes x-go-package: cohesity/iris/server/data/public 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 CouchbaseCluster: description: Specifies an Object containing information about a couchbase cluster. type: object title: Couchbase Cluster Info. properties: seeds: description: Seeds of this Couchbase Cluster. type: - array - 'null' items: type: string x-go-name: Seeds x-go-package: cohesity/iris/server/data/public Preferences: type: object title: User's preferences. properties: locale: description: 'Locale reflects the language settings of the user. Populate using the user preferences stored in Scribe for the user wherever needed.' type: - string - 'null' x-go-name: Locale x-go-package: cohesity/iris/server/data/public TagAttribute: description: Specifies a VMware tag. type: object title: VMware Tag Attributes. properties: gcpTagType: description: 'Specifies the tag attribute type of GCP. Going forward, there will be an additional TagTypes for AWS as well. Specifies the type of the tag GCP entity refers to. ''kNetworkTag'' indicates a network tag present on instances. ''kLabel'' indicates a label (key-value pair) present on instances. ''kCustomMetadata'' indicates custom Metadata (key-value pair) present on instances.' type: - string - 'null' enum: - kNetworkTag - kLabel - kCustomMetadata x-go-name: GcpTagType id: description: Specifies the Coheisty id of the VM tag. type: - integer - 'null' format: int64 x-go-name: Id name: description: Specifies the VMware name of the VM tag. type: - string - 'null' x-go-name: Name uuid: description: 'Specifies the VMware Universally Unique Identifier (UUID) of the VM tag.' type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public ThrottlingPolicyParameters: description: Specifies the throttling policy for a registered Protection Source. type: object title: Throttling Policy. properties: enforceMaxStreams: description: 'Specifies whether datastore streams are configured for all datastores that are part of the registered entity. If set to true, number of streams from Cohesity cluster to the registered entity will be limited to the value set for maxConcurrentStreams. If not set or set to false, there is no max limit for the number of concurrent streams.' type: - boolean - 'null' x-go-name: EnforceMaxStreams enforceRegisteredSourceMaxBackups: description: 'Specifies whether no. of backups are configured for the registered entity. If set to true, number of backups made by Cohesity cluster in the registered entity will be limited to the value set for RegisteredSourceMaxConcurrentBackups. If not set or set to false, there is no max limit for the number of concurrent backups.' type: - boolean - 'null' x-go-name: EnforceRegisteredSourceMaxBackups isEnabled: description: 'Indicates whether read operations to the datastores, which are part of the registered Protection Source, are throttled.' type: - boolean - 'null' x-go-name: IsEnabled latencyThresholds: description: 'Specifies the thresholds that should be applied to all datastores that are part of the registered Object.' $ref: '#/components/schemas/LatencyThresholds' maxConcurrentStreams: description: 'Specifies the limit on the number of streams Cohesity cluster will make concurrently to the datastores of the registered entity. This limit is enforced only when the flag enforceMaxStreams is set to true.' type: - integer - 'null' format: int32 x-go-name: MaxConcurrentStreams registeredSourceMaxConcurrentBackups: description: 'Specifies the limit on the number of backups Cohesity cluster will make concurrently to the registered entity. This limit is enforced only when the flag enforceRegisteredSourceMaxBackups is set to true.' type: - integer - 'null' format: int32 x-go-name: RegisteredSourceMaxConcurrentBackups x-go-package: cohesity/iris/server/data/public 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 ProtectionJobInfo: description: Specifies basic information about a Protection Job. type: object title: Protection Job Info properties: jobId: description: Specifies the id of the Protection Job. type: - integer - 'null' format: int64 x-go-name: JobId jobName: description: Specifies the name of the Protection Job. type: - string - 'null' x-go-name: JobName type: description: 'Specifies the type of the Protection Job such as kView or kPuppeteer. ''kPuppeteer'' refers to a Remote Adapter Job. Supported environment types such as ''kView'', ''kSQL'', ''kVMware'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter. ''kVMware'' indicates the VMware Protection Source environment. ''kHyperV'' indicates the HyperV Protection Source environment. ''kSQL'' indicates the SQL Protection Source environment. ''kView'' indicates the View Protection Source environment. ''kPuppeteer'' indicates the Cohesity''s Remote Adapter. ''kPhysical'' indicates the physical Protection Source environment. ''kPure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''kAzure'' indicates the Microsoft''s Azure Protection Source environment. ''kNetapp'' indicates the Netapp Protection Source environment. ''kAgent'' indicates the Agent Protection Source environment. ''kGenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''kAcropolis'' indicates the Acropolis Protection Source environment. ''kPhsicalFiles'' indicates the Physical Files Protection Source environment. ''kIsilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''kGPFS'' indicates IBM''s GPFS Protection Source environment. ''kKVM'' indicates the KVM Protection Source environment. ''kAWS'' indicates the AWS Protection Source environment. ''kExchange'' indicates the Exchange Protection Source environment. ''kHyperVVSS'' indicates the HyperV VSS Protection Source environment. ''kOracle'' indicates the Oracle Protection Source environment. ''kGCP'' indicates the Google Cloud Platform Protection Source environment. ''kFlashBlade'' indicates the Flash Blade Protection Source environment. ''kAWSNative'' indicates the AWS Native Protection Source environment. ''kO365'' indicates the Office 365 Protection Source environment. ''kO365Outlook'' indicates Office 365 outlook Protection Source environment. ''kHyperFlex'' indicates the Hyper Flex Protection Source environment. ''kGCPNative'' indicates the GCP Native Protection Source environment. ''kAzureNative'' indicates the Azure Native Protection Source environment. ''kKubernetes'' indicates a Kubernetes Protection Source environment. ''kElastifile'' indicates Elastifile Protection Source environment. ''kAD'' indicates Active Directory Protection Source environment. ''kRDSSnapshotManager'' indicates AWS RDS Protection Source environment. ''kCassandra'' indicates Cassandra Protection Source environment. ''kMongoDB'' indicates MongoDB Protection Source environment. ''kCouchbase'' indicates Couchbase Protection Source environment. ''kHdfs'' indicates Hdfs Protection Source environment. ''kHive'' indicates Hive Protection Source environment. ''kHBase'' indicates HBase Protection Source environment.' type: - string - 'null' enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kNimble - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kAzureNative - kKubernetes - kElastifile - kAD - kRDSSnapshotManager - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase x-go-name: Type x-go-package: cohesity/iris/server/data/public ConnectorParameters: description: 'Specifies the parameters required to establish a connection with a particular environment.' type: object title: Connector Parameters. properties: endpoint: description: 'Specify an IP address or URL of the environment. (such as the IP address of the vCenter Server for a VMware environment).' type: - string - 'null' x-go-name: Endpoint environment: description: 'Specifies the environment like VMware, SQL, where the Protection Source exists. Supported environment types such as ''kView'', ''kSQL'', ''kVMware'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter. ''kVMware'' indicates the VMware Protection Source environment. ''kHyperV'' indicates the HyperV Protection Source environment. ''kSQL'' indicates the SQL Protection Source environment. ''kView'' indicates the View Protection Source environment. ''kPuppeteer'' indicates the Cohesity''s Remote Adapter. ''kPhysical'' indicates the physical Protection Source environment. ''kPure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''kAzure'' indicates the Microsoft''s Azure Protection Source environment. ''kNetapp'' indicates the Netapp Protection Source environment. ''kAgent'' indicates the Agent Protection Source environment. ''kGenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''kAcropolis'' indicates the Acropolis Protection Source environment. ''kPhsicalFiles'' indicates the Physical Files Protection Source environment. ''kIsilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''kGPFS'' indicates IBM''s GPFS Protection Source environment. ''kKVM'' indicates the KVM Protection Source environment. ''kAWS'' indicates the AWS Protection Source environment. ''kExchange'' indicates the Exchange Protection Source environment. ''kHyperVVSS'' indicates the HyperV VSS Protection Source environment. ''kOracle'' indicates the Oracle Protection Source environment. ''kGCP'' indicates the Google Cloud Platform Protection Source environment. ''kFlashBlade'' indicates the Flash Blade Protection Source environment. ''kAWSNative'' indicates the AWS Native Protection Source environment. ''kO365'' indicates the Office 365 Protection Source environment. ''kO365Outlook'' indicates Office 365 outlook Protection Source environment. ''kHyperFlex'' indicates the Hyper Flex Protection Source environment. ''kGCPNative'' indicates the GCP Native Protection Source environment. ''kAzureNative'' indicates the Azure Native Protection Source environment. ''kKubernetes'' indicates a Kubernetes Protection Source environment. ''kElastifile'' indicates Elastifile Protection Source environment. ''kAD'' indicates Active Directory Protection Source environment. ''kRDSSnapshotManager'' indicates AWS RDS Protection Source environment. ''kCassandra'' indicates Cassandra Protection Source environment. ''kMongoDB'' indicates MongoDB Protection Source environment. ''kCouchbase'' indicates Couchbase Protection Source environment. ''kHdfs'' indicates Hdfs Protection Source environment. ''kHive'' indicates Hive Protection Source environment. ''kHBase'' indicates HBase Protection Source environment.' type: - string - 'null' enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kNimble - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kAzureNative - kKubernetes - kElastifile - kAD - kRDSSnapshotManager - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase x-go-name: Environment id: description: 'Specifies a Unique id that is generated when the Source is registered. This is a convenience field that is used to maintain an index to different connection params.' type: - integer - 'null' format: int64 x-go-name: Id version: description: 'Version is updated each time the connector parameters are updated. This is used to discard older connector parameters.' type: - integer - 'null' format: int64 x-go-name: Version x-go-package: cohesity/iris/server/data/public DagApplicationServerInfo: description: 'Specifies the information about the status of the Exchange Application Server which is a member of the DAG.' type: object title: Exchange DAG Application Server Information properties: fqdn: description: Specifies the fully qualified domain name of the Exchange Server. type: - string - 'null' x-go-name: Fqdn guid: description: Specifies the Guid of the Exchange Application Server. type: - string - 'null' x-go-name: Guid id: description: Specifies the entity id of the Exchange Application server. type: - integer - 'null' format: int64 x-go-name: Id name: description: Specifies the display name of the Exchange Application Server. type: - string - 'null' x-go-name: Name ownerId: description: 'Specifies the entity id of the owner entity of the Exchange Application Server.' type: - integer - 'null' format: int64 x-go-name: OwnerId status: description: 'Specifies the status of the registration of the Exchange Application Server. Specifies the status of registration of Exchange Application Server. ''kUnknown'' indicates the status is not known. ''kHealthy'' indicates the status is healty and is registered as Exchange Server. ''kUnHealthy'' indicates the exchange application is registered on the physical server but it is unreachable now. ''kUnregistered'' indicates the server is not registered as physical source. ''kUnreachable'' indicates the server is not reachable from the cohesity cluster or the cohesity protection server is not installed on the exchange server. ''kDetached'' indicates the server is removed from the ExchangeDAG.' type: - string - 'null' enum: - kUnknown - kHealthy - kUnHealthy - kUnregistered - kUreachable - kDetached x-go-name: Status totalSizeBytes: description: 'Specifies the total size of all Exchange database copies in all the Exchange Application Servers that are part of the DAG.' type: - integer - 'null' format: int64 x-go-name: TotalSizeBytes x-go-package: cohesity/iris/server/data/public VirtualDiskInfo: type: object title: Virtual Disk Information. properties: busNumber: description: Specifies the Id of the controller bus that controls the disk. type: - integer - 'null' format: int64 x-go-name: BusNumber controllerType: description: Specifies the controller type like SCSI, or IDE etc. type: - string - 'null' x-go-name: ControllerType filename: description: Specifies the host file name used as the virtual disk. type: - string - 'null' x-go-name: Filename unitNumber: description: 'Specifies the disk file name. This is the VMDK name and not the flat file name.' type: - integer - 'null' format: int64 x-go-name: UnitNumber x-go-package: cohesity/iris/server/data/public SqlSourceId: description: Specifies a unique id for a SQL Protection Source. type: object title: SQL Source Id. properties: createdDateMsecs: description: 'Specifies a unique identifier generated from the date the database is created or renamed. Cohesity uses this identifier in combination with the databaseId to uniquely identify a database.' type: - integer - 'null' format: int64 x-go-name: CreatedDateMsecs databaseId: description: 'Specifies a unique id of the database but only for the life of the database. SQL Server may reuse database ids. Cohesity uses the createDateMsecs in combination with this databaseId to uniquely identify a database.' type: - integer - 'null' format: int64 x-go-name: DatabaseId instanceId: description: 'Array of bytes that stores the SQL Server Instance id. Specifies unique id for the SQL Server instance. This id does not change during the life of the instance.' type: - array - 'null' items: type: integer format: uint8 x-go-name: InstanceId x-go-package: cohesity/iris/server/data/public AwsProtectionSource: description: Specifies a Protection Source in AWS environment. type: object title: AWS Protection Source. properties: accessKey: description: Specifies Access key of the AWS account. type: - string - 'null' x-go-name: AccessKey amazonResourceName: description: 'Specifies Amazon Resource Name (owner ID) of the IAM user, act as an unique identifier of as AWS entity.' type: - string - 'null' x-go-name: AmazonResourceName authMethod: description: 'Specifies the authentication method to be used for API calls. Specifies the authentication method to be used for API calls. ''kUseIAMUser'' indicates a user based authentication. ''kUseIAMRole'' indicates a role based authentication, used only for AWS CE.' type: - string - 'null' enum: - kUseIAMUser - kUseIAMRole x-go-name: AuthMethod awsFleetParams: description: 'Specifies information related to AWS fleets launched for various purposes. This will only be set for kIAMUser entity.' $ref: '#/components/schemas/AwsFleetParams' awsType: description: 'Specifies the entity type such as ''kIAMUser'' if the environment is kAWS. Specifies the type of an AWS source entity. ''kIAMUser'' indicates a unique user within an AWS account. ''kRegion'' indicates a geographical region in the global infrastructure. ''kAvailabilityZone'' indicates an availability zone within a region. ''kEC2Instance'' indicates a Virtual Machine running in AWS environment. ''kVPC'' indicates a virtual private cloud (VPC) network within AWS. ''kSubnet'' indicates a subnet inside the VPC. ''kNetworkSecurityGroup'' represents a network security group. ''kInstanceType'' represents various machine types. ''kKeyPair'' represents a pair of public and private key used to login into a Virtual Machine. ''kTag'' represents a tag attached to EC2 instance. ''kRDSOptionGroup'' represents a RDS option group for configuring database features. ''kRDSParameterGroup'' represents a RDS parameter group. ''kRDSInstance'' represents a RDS DB instance. ''kRDSSubnet'' represents a RDS subnet. ''kRDSTag'' represents a tag attached to RDS instance.' type: - string - 'null' enum: - kIAMUser - kRegion - kAvailabilityZone - kEC2Instance - kVPC - kSubnet - kNetworkSecurityGroup - kInstanceType - kKeyPair - kTag - kRDSOptionGroup - kRDSParameterGroup - kRDSInstance - kRDSSubnet - kRDSTag x-go-name: AwsType clusterNetworkInfo: description: 'Specifies information related to cluster. This is only valid for CE clusters. This is only populated for kIAMUser entity.' $ref: '#/components/schemas/FleetNetworkParams' dbEngineId: description: 'Specifies DB engine version info of the entity. This is populated only for RDSInstance, RDSOptionGroup and RDSParameterGroup entity types.' type: - string - 'null' x-go-name: DbEngineId hostType: description: 'Specifies the OS type of the Protection Source of type ''kVirtualMachine'' such as ''kWindows'' or ''kLinux''. overrideDescription: true ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: HostType iamRoleArn: description: 'Specifies the IAM role which will be used to access the security credentials required for API calls.' type: - string - 'null' x-go-name: IamRoleArn ipAddresses: description: Specifies the IP address of the entity of type 'kVirtualMachine'. type: - string - 'null' x-go-name: IpAddress name: description: 'Specifies the name of the Object set by the Cloud Provider. If the provider did not set a name for the object, this field is not set.' type: - string - 'null' x-go-name: Name ownerId: description: 'Specifies the owner id of the resource in AWS environment. With type, name and ownerId gives a globally unique identity to the AWS entity.' type: - string - 'null' x-go-name: OwnerId physicalSourceId: description: 'Specifies the Protection Source id of the registered Physical Host. If the cloud entity is protected using a Physical Agent, it must be registered as a physical host.' type: - integer - 'null' format: int64 x-go-name: PhysicalSourceId regionId: description: Specifies the region Id of the entity if the entity is an EC2 instance. type: - string - 'null' x-go-name: RegionId resourceId: description: Specifies the unique Id of the resource given by the cloud provider. type: - string - 'null' x-go-name: ResourceId restoreTaskId: description: 'Specifies the id of the "convert and deploy" restore task that created the entity in the cloud. It is required to support the DR-to-cloud usecase where we replicate an on-prem entity to a cluster running in cloud, bring it up using "convert and deploy" mechanism, protect it using a cloud job that uses physical adapter, and convert it back to the on-prem format before replication. Before replicating, we need to update the backup task state of the backed up entity using the on-prem entity and on-prem entity''s parent. The id is used to lookup the restore entity that contains details about the on-prem entity. It is set at the time of refreshing the cloud entity hierarchy if all the following conditions are met: Name of the current entity matches with name of any cloud entity deployed using the "convert and deploy" restore task. Restore entity associated with the above matched cloud entity has ''failed_over'' flag set to true in its cloud extension.' type: - integer - 'null' format: int64 x-go-name: RestoreTaskId secretAccessKey: description: Specifies Secret Access key of the AWS account. type: - string - 'null' x-go-name: SecretAccessKey subscriptionType: description: 'Specifies the subscription type of AWS such as ''kAWSCommercial'' or ''kAWSGovCloud''. Specifies the subscription type of an AWS source entity. ''kAWSCommercial'' indicates a standard AWS subscription. ''kAWSGovCloud'' indicates a govt AWS subscription.' type: - string - 'null' enum: - kAWSCommercial - kAWSGovCloud x-go-name: SubscriptionType tagAttributes: description: Specifies the list of AWS tag attributes. type: - array - 'null' items: $ref: '#/components/schemas/TagAttribute' x-go-name: TagAttributes type: description: 'Specifies the type of an AWS Protection Source Object such as ''kStorageContainer'', ''kVirtualMachine'', ''kVirtualNetwork'', etc. Specifies the type of an AWS source entity. ''kIAMUser'' indicates a unique user within an AWS account. ''kRegion'' indicates a geographical region in the global infrastructure. ''kAvailabilityZone'' indicates an availability zone within a region. ''kEC2Instance'' indicates a Virtual Machine running in AWS environment. ''kVPC'' indicates a virtual private cloud (VPC) network within AWS. ''kSubnet'' indicates a subnet inside the VPC. ''kNetworkSecurityGroup'' represents a network security group. ''kInstanceType'' represents various machine types. ''kKeyPair'' represents a pair of public and private key used to login into a Virtual Machine. ''kTag'' represents a tag attached to EC2 instance. ''kRDSOptionGroup'' represents a RDS option group for configuring database features. ''kRDSParameterGroup'' represents a RDS parameter group. ''kRDSInstance'' represents a RDS DB instance. ''kRDSSubnet'' represents a RDS subnet. ''kRDSTag'' represents a tag attached to RDS instance.' type: - string - 'null' enum: - kIAMUser - kRegion - kAvailabilityZone - kEC2Instance - kVPC - kSubnet - kNetworkSecurityGroup - kInstanceType - kKeyPair - kTag - kRDSOptionGroup - kRDSParameterGroup - kRDSInstance - kRDSSubnet - kRDSTag x-go-name: Type userAccountId: description: Specifies the account id derived from the ARN of the user. type: - string - 'null' x-go-name: UserAccountId userResourceName: description: Specifies the Amazon Resource Name (ARN) of the user. type: - string - 'null' x-go-name: UserResourceName x-go-package: cohesity/iris/server/data/public HostSettingsCheckResult: description: Specifies the result of various checks performed internally on host. type: object title: Host Setting Check Result. properties: checkType: description: 'Specifies the type of the check internally performed. Specifies the type of the host check performed internally. ''kIsAgentPortAccessible'' indicates the check for agent port access. ''kIsAgentRunning'' indicates the status for the Cohesity agent service. ''kIsSQLWriterRunning'' indicates the status for SQLWriter service. ''kAreSQLInstancesRunning'' indicates the run status for all the SQL instances in the host. ''kCheckServiceLoginsConfig'' checks the privileges and sysadmin status of the logins used by the SQL instance services, Cohesity agent service and the SQLWriter service. ''kCheckSQLFCIVIP'' checks whether the SQL FCI is registered with a valid VIP or FQDN. ''kCheckSQLDiskSpace'' checks whether volumes containing SQL DBs have at least 10% free space.' type: - string - 'null' enum: - kIsAgentPortAccessible - kIsAgentRunning - kIsSQLWriterRunning - kAreSQLInstancesRunning - kCheckServiceLoginsConfig - kCheckSQLFCIVIP - kCheckSQLDiskSpace x-go-name: CheckType resultType: description: 'Specifies the type of the result returned after performing the internal host check. Specifies the type of the host check result performed internally. ''kPass'' indicates that the respective check was successful. ''kFail'' indicates that the respective check failed as some mandatory setting is not met ''kWarning'' indicates that the respective check has warning as certain non-mandatory setting is not met.' type: - string - 'null' enum: - kPass - kFail - kWarning x-go-name: ResultType userMessage: description: Specifies a descriptive message for failed/warning types. type: - string - 'null' x-go-name: UserMessage x-go-package: cohesity/iris/server/data/public StoragePolicyOverride: description: 'Specifies if inline deduplication and compression settings inherited from Storage Domain (View Box) should be disabled for this View.' type: object title: Storage Policy Override. properties: disableInlineDedupAndCompression: description: 'If false, the inline deduplication and compression settings inherited from the Storage Domain (View Box) apply to this View. If true, both inline deduplication and compression are disabled for this View. This can only be set to true if inline deduplication is set for the Storage Domain (View Box).' type: - boolean - 'null' x-go-name: DisableInlineDedupAndCompression x-go-package: cohesity/iris/server/data/public 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 UpdateApiKeyParams: description: Specifies the parameters to update an API key. type: object title: Parameters to update an API key. required: - name properties: expiringTimeMsecs: description: Specifies a time stamp when the API key will expire in milli seconds. type: - integer - 'null' format: int64 x-go-name: ExpiringTimeMsecs isActive: description: 'Specifies if the API key is active. Only an active and not expired API key can be used for authentication.' type: - boolean - 'null' x-go-name: IsActive name: description: Specifies the name of API key. type: - string - 'null' x-go-name: Name x-go-package: cohesity/iris/server/data/public VolumeSecurityInfo: description: Specifies information about NetApp volume security settings. type: object title: Volume Security Information. properties: groupId: description: Specifies the Unix group ID for this volume. 0 indicates the root id. type: - integer - 'null' format: int32 x-go-name: GroupId permissions: description: Specifies the Unix permission bits in octal string format. type: - string - 'null' x-go-name: Permissions style: description: 'Specifies the security style associated with this volume. Specifies the type of a NetApp Volume. ''kUnix'' indicates Unix-style security. ''kNtfs'' indicates Windows NTFS-style security. ''kMixed'' indicates mixed-style security. ''kUnified'' indicates Unified-style security.' type: - string - 'null' enum: - kUnix - kNtfs - kMixed - kUnified x-go-name: Style userId: description: Specifies the Unix user id for this volume. 0 indicates the root id. type: - integer - 'null' format: int32 x-go-name: UserId x-go-package: cohesity/iris/server/data/public HiveConnectParams: description: 'Specifies an Object containing information about a registered Hive source.' type: object title: Hive Connect Params. properties: hdfsEntityId: description: Specifies the entity id of the HDFS source for this Hive type: - integer - 'null' format: int64 x-go-name: HdfsEntityId kerberosPrincipal: description: Specifies the kerberos principal. type: - string - 'null' x-go-name: KerberosPrincipal metastore: description: Specifies the Hive metastore host. type: - string - 'null' x-go-name: Metastore thriftPort: description: Specifies the Hive metastore thrift Port type: - integer - 'null' format: int32 x-go-name: ThriftPort x-go-package: cohesity/iris/server/data/public DatastoreInfo: type: object title: Datastore Information. properties: capacity: description: Specifies the capacity of the datastore in bytes. type: - integer - 'null' format: uint64 x-go-name: Capacity freeSpace: description: Specifies the available space on the datastore in bytes. type: - integer - 'null' format: uint64 x-go-name: FreeSpace x-go-package: cohesity/iris/server/data/public SmbPermissionsInfo: description: Specifies information about SMB permissions. type: object title: SMB Permissions Information. properties: ownerSid: description: Specifies the security identifier (SID) of the owner of the SMB share. type: - string - 'null' x-go-name: OwnerSid permissions: description: 'Array of SMB Permissions. Specifies a list of SMB permissions.' type: - array - 'null' items: $ref: '#/components/schemas/SmbPermission' x-go-name: Permissions x-go-package: cohesity/iris/server/data/public ClusterIdentifier: type: object title: ClusterIdentifier uniquely identifies a cluster. properties: clusterId: description: Specifies the cluster id of the cluster. type: - integer - 'null' format: int64 x-go-name: ClusterId clusterIncarnationId: description: Specifies the cluster incarnation id. type: - integer - 'null' format: int64 x-go-name: ClusterIncarnationId x-go-package: cohesity/iris/server/data/public 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 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 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 ApiKey: description: Specifies the parameters of an API key. type: object title: API key. properties: createdTimeMsecs: description: Specifies the API key created time in milli seconds. type: - integer - 'null' format: int64 x-go-name: CreatedTimeMsecs createdUserSid: description: Specifies the user sid who created this API key. type: - string - 'null' x-go-name: CreatedUserSid createdUsername: description: Specifies the username who created this API key. type: - string - 'null' x-go-name: CreatedUsername expiringTimeMsecs: description: Specifies a time stamp when the API key will expire in milli seconds. type: - integer - 'null' format: int64 x-go-name: ExpiringTimeMsecs id: description: Specifies the API key id. type: - string - 'null' x-go-name: Id isActive: description: 'Specifies if the API key is active. Only an active and not expired API key can be used for authentication.' type: - boolean - 'null' x-go-name: IsActive isExpired: description: 'Specifies if the API key is expired. Expired API keys cannot be used for authentication.' type: - boolean - 'null' x-go-name: IsExpired name: description: Specifies the API key name. type: - string - 'null' x-go-name: Name ownerUserSid: description: Specifies the user sid who owns this API key. type: - string - 'null' x-go-name: OwnerUserSid ownerUsername: description: Specifies the username who owns this API key. type: - string - 'null' x-go-name: OwnerUsername 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 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 ViewProtection: description: 'Specifies information about the Protection Jobs that are protecting the View.' type: object title: View Protection. properties: inactive: description: 'Specifies if this View is an inactive View that was created on this Remote Cluster to store the Snapshots created by replication. This inactive View cannot be NFS or SMB mounted.' type: - boolean - 'null' x-go-name: Inactive magnetoEntityId: description: Specifies the id of the Protection Source that is using this View. type: - integer - 'null' format: int64 x-go-name: MagnetoEntityId protectionJobs: description: 'Array of Protection Jobs. Specifies the Protection Jobs that are protecting the View.' type: - array - 'null' items: $ref: '#/components/schemas/ProtectionJobInfo' x-go-name: ProtectionJobs x-go-package: cohesity/iris/server/data/public 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 FileExtensionFilter: type: object properties: fileExtensionsList: description: The list of file extensions to apply type: - array - 'null' items: type: string x-go-name: FileExtensionsList isEnabled: description: If set, it enables the file extension filter type: - boolean - 'null' x-go-name: IsEnabled mode: description: 'The mode applied to the list of file extensions ''kWhitelist'' indicates a whitelist extension filter. ''kBlacklist'' indicates a blacklist extension filter.' type: - string - 'null' enum: - kWhitelist - kBlacklist x-go-name: Mode x-go-package: cohesity/iris/server/data/public NasProtectionSource: description: Specifies a Protection Source in a Generic NAS environment. type: object title: Generic NAS Protection Source. properties: description: description: Specifies a description about the Protection Source. type: - string - 'null' x-go-name: Description mountPath: description: 'Specifies the mount path of this NAS. For example, for a NFS mount point, this should be in the format of IP or hostname:/foo/bar.' type: - string - 'null' x-go-name: MountPath name: description: Specifies the name of the NetApp Object. type: - string - 'null' x-go-name: Name protocol: description: 'Specifies the protocol used by the NAS server. Specifies the protocol used by a NAS server. ''kNfs3'' indicates NFS v3 protocol. ''kCifs1'' indicates CIFS v1.0 protocol.' type: - string - 'null' enum: - kNfs3 - kCifs1 x-go-name: Protocol skipValidation: description: Specifies whether to skip validation of the given mount point. type: - boolean - 'null' x-go-name: SkipValidation type: description: 'Specifies the type of a Protection Source Object in a generic NAS Source such as ''kGroup'', or ''kHost''. Specifies the kind of NAS mount. ''kGroup'' indicates top level node that holds individual NAS hosts. ''kHost'' indicates a single NAS path that can be mounted. ''kDfsGroup'' indicates a DFS group containing top level directories mapped to different servers. ''kDfsTopDir'' indicates a top level directory inside a DFS group, discovered when registering a DFS group.' type: - string - 'null' enum: - kGroup - kHost - kDfsGroup - kDfsTopDir x-go-name: Type x-go-package: cohesity/iris/server/data/public TenantConfig: description: Specifies struct with basic tenant specific configuration. type: object title: Tenant Config. properties: name: description: Specifies name of the tenant. type: - string - 'null' x-go-name: Name restricted: description: 'Whether the user is a restricted user. A restricted user can only view the objects he has permissions to.' type: - boolean - 'null' x-go-name: Restricted roles: description: 'Array of Roles. Specifies the Cohesity roles to associate with the user such as such as ''Admin'', ''Ops'' or ''View''. The Cohesity roles determine privileges on the Cohesity Cluster for this user.' type: - array - 'null' items: type: string x-go-name: Roles tenantId: description: Specifies the unique id of the tenant. type: - string - 'null' x-go-name: TenantId x-go-package: cohesity/iris/server/data/public 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 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 FleetNetworkParams: description: Specifies the various network params for the fleet. type: object title: Fleet Network Parameters. properties: region: description: Specifies the region for the fleet. type: - string - 'null' x-go-name: Region subnet: description: Specifies the subnet for the fleet. type: - string - 'null' x-go-name: Subnet vpc: description: Specifies the vpc for the fleet. type: - string - 'null' x-go-name: Vpc x-go-package: cohesity/iris/server/data/public ExchangeDatabaseInfo: description: Specifies the information about the Exchange Database. type: object title: Exchange Database Information properties: appServerId: description: 'Specifies the entity id of the Exchange Application Server which has this database copy.' type: - integer - 'null' format: int64 x-go-name: AppServerId backupSupported: description: Specifies if backup is supported for the Exchange database copy. type: - boolean - 'null' x-go-name: BackupSupported backupUnsupportedReasons: description: Specifies any reason(s) for Exchange database backup not supported. type: - array - 'null' items: type: string x-go-name: BackupUnsupportedReasons createdTimeMsecs: description: 'Specifies the time when the database is created in Unix epoch time in milliseconds.' type: - integer - 'null' format: int64 x-go-name: CreatedTimeMsecs databaseState: description: 'Specifies the state of the Exchange database copy. Specifies the state of Exchange Database Copy. ''kUnknown'' indicates the status is not known. ''kMounted'' indicates the exchange database copy is mounted and healthy. ''kError'' indicates the exchange database copy is unmounted or partially mounted or is in error state.' type: - string - 'null' enum: - kUnknown - kMounted - kError x-go-name: DatabaseState dbSizeBytes: description: Specifies the size of the Exchange database copy in bytes. type: - integer - 'null' format: int64 x-go-name: DbSizeBytes dbguid: description: Specifies the guid of the Exchange Database. type: - string - 'null' x-go-name: DbGuid name: description: Specifes the name of the Exchange Database. type: - string - 'null' x-go-name: Name ownerId: description: 'Specifies the owner entity id of the Exchange Application Server which has this database copy.' type: - integer - 'null' format: int64 x-go-name: OwnerId utcOffsetMin: description: Specifies UTC time offset of database creation time. type: - integer - 'null' format: int64 x-go-name: UtcOffsetMin x-go-package: cohesity/iris/server/data/public VMwareProtectionSource: description: Specifies a Protection Source in a VMware environment. type: object title: VMware Protection Source. properties: agentId: description: Specifies the id of the persistent agent. type: - integer - 'null' format: int64 x-go-name: AgentId agents: description: 'Specifies the list of agent information on the Virtual Machine. This is set only if the Virtual Machine has persistent agent.' type: - array - 'null' items: $ref: '#/components/schemas/AgentInformation' x-go-name: Agents connectionState: description: 'Specifies the connection state of the Object and are only valid for ESXi hosts (''kHostSystem'') or Virtual Machines (''kVirtualMachine''). These enums are equivalent to the connection states documented in VMware''s reference documentation. Examples of Cohesity connection states include ''kConnected'', ''kDisconnected'', ''kInacccessible'', etc. ''kConnected'' indicates that server has access to virtual machine. ''kDisconnected'' indicates that server is currently disconnected to virtual machine. ''kInaccessible'' indicates that one or more configuration files are inacccessible. ''kInvalid'' indicates that virtual machine configuration is invalid. ''kOrphaned'' indicates that virtual machine is no longer registered on the host it is associated with. ''kNotResponding'' indicates that virtual machine has failed to respond due to external issues such as network connectivity, host not running etc.' type: - string - 'null' enum: - kConnected - kDisconnected - kInaccessible - kInvalid - kOrphaned - kNotResponding x-go-name: ConnectionState datastoreInfo: description: Specifies additional information of entities of type 'kDatastore'. $ref: '#/components/schemas/DatastoreInfo' folderType: description: 'Specifies the folder type for the ''kFolder'' Object. ''kVMFolder'' indicates folder can hold VMs or vApps. ''kHostFolder'' indicates folder can hold hosts and compute resources. ''kDatastoreFolder'' indicates folder can hold datastores and storage pods. ''kNetworkFolder'' indicates folder can hold networks and switches. ''kRootFolder'' indicates folder can hold datacenters.' type: - string - 'null' enum: - kVMFolder - kHostFolder - kDatastoreFolder - kNetworkFolder - kRootFolder x-go-name: FolderType hasPersistentAgent: description: 'Set to true if a persistent agent is running on the Virtual Machine. This is populated for entities of type ''kVirtualMachine''.' type: - boolean - 'null' x-go-name: HasPersistentAgent hostType: description: 'Specifies the host type for the ''kVirtualMachine'' Object. ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: HostType id: description: Specifies the UUID of the VMware Protection Source. $ref: '#/components/schemas/VMwareObjectId' ipDetails: description: This field can be used to capture IP Addresses for entities that have it. $ref: '#/components/schemas/IpDetails' isVmTemplate: description: IsTemplate specifies if the VM is a template or not. type: - boolean - 'null' x-go-name: IsVmTemplate name: description: Specifies a human readable name of the Protection Source. type: - string - 'null' x-go-name: Name tagAttributes: description: 'Specifies the optional list of VM Tag attributes associated with this Object.' type: - array - 'null' items: $ref: '#/components/schemas/TagAttribute' x-go-name: TagAttributes toolsRunningStatus: description: 'Specifies the status of VMware Tools for the guest OS on the VM. This is only valid for the ''kVirtualMachine'' type. ''kGuestToolsRunning'' means the VMware tools are running on the guest OS. ''kGuestToolsNotRunning'' means the VMware tools are not running on the guest OS. ''kUnknown'' means the state of the VMware tools on the guest OS is not known. ''kGuestToolsExecutingScripts'' means the guest OS is currently executing scripts using VMware tools.' type: - string - 'null' enum: - kUnknown - kGuestToolsExecutingScripts - kGuestToolsNotRunning - kGuestToolsRunning x-go-name: VMwareToolsRunningStatus type: description: 'Specifies the type of managed Object in a VMware Protection Source. Examples of VMware Objects include ''kVCenter'', ''kFolder'', ''kDatacenter'', ''kResourcePool'', ''kDatastore'', ''kVirtualMachine'', etc. ''kVCenter'' indicates the vCenter entity in a VMware protection source type. ''kFolder indicates the folder entity (of any kind) in a VMware protection source type. ''kDatacenter'' indicates the datacenter entity in a VMware protection source type. ''kComputeResource'' indicates the physical compute resource entity in a VMware protection source type. ''kResourcePool'' indicates the set of physical resources within a compute resource or cloudcompute resource. ''kDataStore'' indicates the datastore entity in a VMware protection source type. ''kHostSystem'' indicates the ESXi host entity in a VMware protection source type. ''kVirtualMachine'' indicates the virtual machine entity in a VMware protection source type. ''kVirtualApp'' indicates the virtual app entity in a VMware protection source type. ''kStandaloneHost'' indicates the standalone ESXi host entity (not managed by vCenter) in a VMware protection source type. ''kStoragePod'' indicates the storage pod entity in a VMware protection source type. ''kNetwork'' indicates the standard vSwitch in a VMware protection source type. ''kDistributedVirtualPortgroup'' indicates a distributed vSwitch port group in a VMware protection source type. ''kTagCategory'' indicates a tag category entity in a VMware protection source type. ''kTag'' indicates a tag entity in a VMware protection source type. ''kOpaqueNetwork'' indicates an opaque network which is created and managed by an entity outside of vSphere. ''kvCloudDirector'' indicates a vCloud director entity in a VMware protection source type. ''kOrganization'' indicates an Organization under a vCD in a VMware protection source type. ''kVirtualDatacenter'' indicates a virtual datacenter entity in a VMware protection source type. ''kCatalog'' indicates a VCD catalog entity in a VMware protection source type. ''kOrgMetadata'' indicates an VCD organization metadata in a VMware protection source type. ''kStoragePolicy'' indicates a storage policy associated with the vApp in a VMware protection source type.' type: - string - 'null' enum: - kVCenter - kFolder - kDatacenter - kComputeResource - kClusterComputeResource - kResourcePool - kDatastore - kHostSystem - kVirtualMachine - kVirtualApp - kStandaloneHost - kStoragePod - kNetwork - kDistributedVirtualPortgroup - kTagCategory - kTag - kOpaqueNetwork - kvCloudDirector - kOrganization - kVirtualDatacenter - kCatalog - kOrgMetadata - kStoragePolicy x-go-name: Type vCloudDirectorInfo: description: Specifies an array of vCenters to be registered type: - array - 'null' items: $ref: '#/components/schemas/VCloudDirectorInfo' x-go-name: VCloudDirectorInfo version: description: 'For vCenter and ESXi, this will show the software version. For VMs, this will show the hardware version.' type: - string - 'null' x-go-name: Version virtualDisks: description: 'Specifies an array of virtual disks that are part of the Virtual Machine. This is populated for entities of type ''kVirtualMachine''.' type: - array - 'null' items: $ref: '#/components/schemas/VirtualDiskInfo' x-go-name: VirtualDisks x-go-package: cohesity/iris/server/data/public 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 DataUsageStats: description: 'Specifies the data usage metric of the data stored on the Cohesity Cluster or Storage Domains (View Boxes).' type: object title: Data Usage Statistics. properties: cloudDataWrittenBytes: description: 'Specifies the total data written on cloud tiers, as computed by the Cohesity Cluster.' type: - integer - 'null' format: int64 x-go-name: CloudDataWrittenBytes cloudDataWrittenBytesTimestampUsec: description: Specifies Timestamp of CloudDataWrittenBytes. type: - integer - 'null' format: int64 x-go-name: CloudDataWrittenBytesTimestampUsec cloudTotalPhysicalUsageBytes: description: 'Specifies the total cloud capacity, as computed by the Cohesity Cluster, after the size of the data has been reduced by change-block tracking, compression and deduplication.' type: - integer - 'null' format: int64 x-go-name: CloudTotalPhysicalUsageBytes cloudTotalPhysicalUsageBytesTimestampUsec: description: Specifies Timestamp of CloudTotalPhysicalUsageBytes. type: - integer - 'null' format: int64 x-go-name: CloudTotalPhysicalUsageBytesTimestampUsec dataInBytes: description: 'Specifies the data read from the protected objects by the Cohesity Cluster before any data reduction using deduplication and compression.' type: - integer - 'null' format: int64 x-go-name: DataInBytes dataInBytesAfterDedup: description: 'Specifies the size of the data has been reduced by change-block tracking and deduplication but before compression or data is replicated to other nodes as per RF or Erasure Coding policy.' type: - integer - 'null' format: int64 x-go-name: DataInBytesAfterDedup dataInBytesAfterDedupTimestampUsec: description: Specifies Timestamp of DataInBytesAfterDedup. type: - integer - 'null' format: int64 x-go-name: DataInBytesAfterDedupTimestampUsec dataInBytesTimestampUsec: description: Specifies Timestamp of DataInBytes. type: - integer - 'null' format: int64 x-go-name: DataInBytesTimestampUsec dataProtectLogicalUsageBytes: description: Specifies the logical data used by Data Protect on Cohesity cluster. type: - integer - 'null' format: int64 x-go-name: DataProtectLogicalUsageBytes dataProtectLogicalUsageBytesTimestampUsec: description: Specifies Timestamp of DataProtectLogicalUsageBytes. type: - integer - 'null' format: int64 x-go-name: DataProtectLogicalUsageBytesTimestampUsec dataProtectPhysicalUsageBytes: description: Specifies the physical data used by Data Protect on Cohesity cluster. type: - integer - 'null' format: int64 x-go-name: DataProtectPhysicalUsageBytes dataProtectPhysicalUsageBytesTimestampUsec: description: Specifies Timestamp of DataProtectPhysicalUsageBytes. type: - integer - 'null' format: int64 x-go-name: DataProtectPhysicalUsageBytesTimestampUsec dataWrittenBytes: description: 'Specifies the data written after it has been reduced by deduplication and compression. This does not include resiliency impact.' type: - integer - 'null' format: int64 x-go-name: DataWrittenBytes dataWrittenBytesTimestampUsec: description: Specifies Timestamp of DataWrittenBytes. type: - integer - 'null' format: int64 x-go-name: DataWrittenBytesTimestampUsec fileServicesLogicalUsageBytes: description: Specifies the logical data used by File services on Cohesity cluster. type: - integer - 'null' format: int64 x-go-name: FileServicesLogicalUsageBytes fileServicesLogicalUsageBytesTimestampUsec: description: Specifies Timestamp of FileServicesLogicalUsageBytes. type: - integer - 'null' format: int64 x-go-name: FileServicesLogicalUsageBytesTimestampUsec fileServicesPhysicalUsageBytes: description: Specifies the physical data used by File services on Cohesity cluster. type: - integer - 'null' format: int64 x-go-name: FileServicesPhysicalUsageBytes fileServicesPhysicalUsageBytesTimestampUsec: description: Specifies Timestamp of FileServicesPhysicalUsageBytes. type: - integer - 'null' format: int64 x-go-name: FileServicesPhysicalUsageBytesTimestampUsec localDataWrittenBytes: description: 'Specifies the total data written on local tiers, as computed by the Cohesity Cluster, after the size of the data has been reduced by change-block tracking, deduplication and compression. This does not include resiliency impact.' type: - integer - 'null' format: int64 x-go-name: LocalDataWrittenBytes localDataWrittenBytesTimestampUsec: description: Specifies Timestamp of LocalDataWrittenBytes. type: - integer - 'null' format: int64 x-go-name: LocalDataWrittenBytesTimestampUsec localTierResiliencyImpactBytes: description: 'Specifies the size of the data has been replicated to other nodes as per RF or Erasure Coding policy.' type: - integer - 'null' format: int64 x-go-name: LocalTierResiliencyImpactBytes localTierResiliencyImpactBytesTimestampUsec: description: Specifies Timestamp of LocalTierResiliencyImpactBytes. type: - integer - 'null' format: int64 x-go-name: LocalTierResiliencyImpactBytesTimestampUsec localTotalPhysicalUsageBytes: description: 'Specifies the total local capacity, as computed by the Cohesity Cluster, after the size of the data has been reduced by change-block tracking, compression and deduplication.' type: - integer - 'null' format: int64 x-go-name: LocalTotalPhysicalUsageBytes localTotalPhysicalUsageBytesTimestampUsec: description: Specifies Timestamp of LocalTotalPhysicalUsageBytes. type: - integer - 'null' format: int64 x-go-name: LocalTotalPhysicalUsageBytesTimestampUsec outdatedLogicalUsageBytesTimestampUsec: description: Specifies Timestamp of OutdatedLogicalUsageBytes. type: - integer - 'null' format: int64 x-go-name: OutdatedLogicalUsageBytesTimestampUsec storageConsumedBytes: description: 'Specifies the total capacity, as computed by the Cohesity Cluster, after the size of the data has been reduced by change-block tracking, compression and deduplication. This includes resiliency impact.' type: - integer - 'null' format: int64 x-go-name: StorageConsumedBytes storageConsumedBytesTimestampUsec: description: Specifies Timestamp of StorageConsumedBytes. type: - integer - 'null' format: int64 x-go-name: StorageConsumedBytesTimestampUsec totalLogicalUsageBytes: description: 'Provides the combined data residing on protected objects. The size of data before reduction by deduplication and compression.' type: - integer - 'null' format: int64 x-go-name: TotalLogicalUsageBytes totalLogicalUsageBytesTimestampUsec: description: Specifies Timestamp of TotalLogicalUsageBytes. type: - integer - 'null' format: int64 x-go-name: TotalLogicalUsageBytesTimestampUsec uniquePhysicalDataBytes: description: Specifies the unique physical data usage in bytes. type: - integer - 'null' format: int64 x-go-name: UniquePhysicalDataBytes x-go-package: cohesity/iris/server/data/public 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 Principal: description: Specifies information about a single Principal. type: object title: Principal. properties: domain: description: 'Specifies the domain name of the where the principal'' account is maintained.' type: - string - 'null' x-go-name: Domain fullName: description: Specifies the full name (first and last names) of the principal. type: - string - 'null' x-go-name: FullName objectClass: description: 'Specifies the object class of the principal (either ''kGroup'' or ''kUser''). ''kUser'' specifies a user object class. ''kGroup'' specifies a group object class. ''kComputer'' specifies a computer object class. ''kWellKnownPrincipal'' specifies a well known principal.' type: - string - 'null' enum: - kUser - kGroup - kComputer - kWellKnownPrincipal x-go-name: ObjectClass principalName: description: Specifies the name of the principal. type: - string - 'null' x-go-name: PrincipalName sid: description: Specifies the unique Security id (SID) of the principal. type: - string - 'null' x-go-name: Sid 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 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 ViewStats: description: Provides statistics about the View. type: object title: View Stats. properties: dataUsageStats: description: Specifies the data usage metric of the data stored in this View. title: Data Usage Statistics. $ref: '#/components/schemas/DataUsageStats' id: description: Specifies the id of the View. type: - integer - 'null' format: int64 x-go-name: Id x-go-package: cohesity/iris/server/data/public UpdateSourcesForPrincipalsParams: description: 'Set Access Permissions for Principals. Specifies a list of principals to set access permissions for. For each principal, set the Protection Sources and View names that the specified principal has permissions to access.' type: object title: Update Sources for Principal Parameters. properties: sourcesForPrincipals: description: 'Array of Principals, Sources and Views. Specifies a list of principals. For each principal, specify the Protection Sources and Views that the principal has permissions to access.' type: - array - 'null' items: $ref: '#/components/schemas/SourceForPrincipalParam' x-go-name: SourcesForPrincipals 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 NfsRootPermissions: description: Specifies the config of NFS root permission of a view file system. type: object title: NfsRootPermissions properties: gid: description: Unix GID for the root of the file system. type: - integer - 'null' format: uint32 x-go-name: Gid mode: description: Unix mode bits for the root of the file system. type: - integer - 'null' format: uint32 x-go-name: Mode uid: description: Unix UID for the root of the file system. type: - integer - 'null' format: uint32 x-go-name: Uid x-go-package: cohesity/iris/server/data/public NisNetgroup: description: Defines an NIS Netgroup. type: object title: Netgroup properties: description: description: Description of the netgroup. type: - string - 'null' x-go-name: Description domain: description: Specifies the domain of the netgroup. type: - string - 'null' x-go-name: Domain name: description: Specifies the name of the netgroup. type: - string - 'null' x-go-name: Name nfsAccess: description: 'Specifies whether clients from this netgroup can mount using NFS protocol. Protocol access level. ''kDisabled'' indicates Protocol access level ''Disabled'' ''kReadOnly'' indicates Protocol access level ''ReadOnly'' ''kReadWrite'' indicates Protocol access level ''ReadWrite''' type: - string - 'null' enum: - kDisabled - kReadOnly - kReadWrite x-go-name: NfsAccess nfsSquash: description: Specifies the NFS squash type. type: - integer - 'null' format: int32 x-go-name: NfsSquash x-go-package: cohesity/iris/server/data/public 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 AntivirusScanConfig: description: Specifies the antivirus scan config settings for this View. type: object title: Antivirus scan config properties: blockAccessOnScanFailure: description: Specifies whether block access to the file when antivirus scan fails. type: - boolean - 'null' x-go-name: BlockAccessOnScanFailure isEnabled: description: Specifies whether the antivirus service is enabled or not. type: - boolean - 'null' x-go-name: IsEnabled maximumScanFileSize: description: 'Specifies maximum file size that will be sent to antivirus server for scanning. if greater than zero, the file size that exceeds this size would be skipped from virus scan.' type: - integer - 'null' format: int64 x-go-name: MaximumScanFileSize scanFilter: description: 'Files extension that meets these filter criteria will be sent to antivirus server for the scan.' $ref: '#/components/schemas/FileExtensionFilter' scanOnAccess: description: Specifies whether to scan a file when it is opened. type: - boolean - 'null' x-go-name: ScanOnAccess scanOnClose: description: Specifies whether to scan a file when it is closed after modify. type: - boolean - 'null' x-go-name: ScanOnClose scanTimeoutUsecs: description: 'Specifies the maximum amount of time that a scan can take before timing out.' type: - integer - 'null' format: int32 x-go-name: ScanTimeoutUsecs x-go-package: cohesity/iris/server/data/public VCloudDirectorInfo: type: object title: VCloudDirectorInfo Information. properties: endpoint: description: vCenter endpoint. type: - string - 'null' x-go-name: Endpoint name: description: vCenter name. type: - string - 'null' x-go-name: Name x-go-package: cohesity/iris/server/data/public 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 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 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 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 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 CreateApiKeyParams: description: Specifies the parameters to create an API key. type: object title: Parameters to create an API key. required: - name properties: expiringTimeMsecs: description: Specifies a time stamp when the API key will expire in milli seconds. type: - integer - 'null' format: int64 x-go-name: ExpiringTimeMsecs isActive: description: 'Specifies if the API key is active. Only an active and not expired API key can be used for authentication.' type: - boolean - 'null' x-go-name: IsActive name: description: Specifies the name of API key. type: - string - 'null' x-go-name: Name x-go-package: cohesity/iris/server/data/public MongoDBCollection: description: Specifies an Object containing information about a mongodb collection. type: object title: MongoDB Collection Info. properties: isCappedCollection: description: Set to true if this is a capped Collection. type: - boolean - 'null' x-go-name: IsCappedCollection isMongoView: description: Set to true if this Collection is a view. type: - boolean - 'null' x-go-name: IsMongoView sizeBytes: description: Size of this Collection. type: - integer - 'null' format: int64 x-go-name: SizeBytes x-go-package: cohesity/iris/server/data/public KvmProtectionSource: description: Specifies a Protection Source in KVM environment. type: object title: KVM Protection Source. properties: agentError: description: Specifies a message when the agent cannot be reached. type: - string - 'null' x-go-name: AgentError agentId: description: 'Specifies the ID of the Agent with which this KVM entity is associated when the entity represents a Delegate host or KVM host.' type: - integer - 'null' format: int64 x-go-name: AgentId clusterId: description: Specifies the cluster ID for 'kCluster' objects. type: - string - 'null' x-go-name: ClusterId datacenterId: description: Specifies the ID of the 'kDatacenter' objects. type: - string - 'null' x-go-name: DatacenterId description: description: Specifies a description about the Protection Source. type: - string - 'null' x-go-name: Description name: description: Specifies the name of the KVM entity. type: - string - 'null' x-go-name: Name networkId: description: Specifies the network ID to which Vnic is attached. type: - string - 'null' x-go-name: NetworkId type: description: 'Specifies the type of KVM Protection Source entities such as ''kDatacenter'', ''kCluster'', ''kVirtualMachine'', etc. Specifies the type of an KVM source entity. ''kOVirtManager'' indicates the root entity registered with Cohesity cluster. ''kStandaloneHost'' indicates a host registered with Cohesity cluster. ''kDatacenter'' indicates a KVM datacenter managed by the OVirt manager. ''kCluster'' indicates a KVM cluster managed by the OVirt manager. ''kHost'' indicates a host within the KVM environment. ''kVirtualMachine'' indicates a virtual machine in the KVM enironment. ''kNetwork'' represents a network used by the virtual machine entity. ''kStorageDomain'' represents a storage domain in the KVM environment. ''kVNicProfile'' represents a VNic profile.' type: - string - 'null' enum: - kOVirtManager - kStandaloneHost - kDatacenter - kCluster - kHost - kVirtualMachine - kNetwork - kStorageDomain - kVNicProfile x-go-name: Type uuid: description: 'Specifies the UUID of the Object. This is unique within the KVM environment.' type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public FleetTag: description: Specfies the key,value pair for the fleet tag. type: object title: Fleet Tag Parameters. properties: key: description: Specifies the key for the fleet tag. type: - string - 'null' x-go-name: Key value: description: Specifies the value for the fleet tag. type: - string - 'null' x-go-name: Value x-go-package: cohesity/iris/server/data/public IscsiSanPort: description: Specifies an iSCSI SAN Port. type: object title: ISCSI SAN Port. properties: ipAddress: description: Specifies the IP address of the SAN port. type: - string - 'null' x-go-name: IpAddress iqn: description: Specifies the qualified name of the iSCSI port (IQN). type: - string - 'null' x-go-name: Iqn tcpPort: description: Specifies the listening port(tcp) of the SAN port. type: - integer - 'null' format: int32 x-go-name: TcpPort x-go-package: cohesity/iris/server/data/public 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 IdpUserInfo: description: 'Specifies an IdP User''s information logged in using an IdP. This information is not stored on the Cluster.' type: object title: IdP User Information. properties: groups: description: 'Specifies the Idp groups that the user is part of. As the user may not be registered on the cluster, we may have to capture the idp group membership. This way, if a group is created on the cluster later, users will instantly have access to tenantIds from that group as well.' type: - array - 'null' items: type: string x-go-name: Groups idpId: description: Specifies the unique Id assigned by the Cluster for the IdP. type: - integer - 'null' format: int64 x-go-name: IdpId issuerId: description: Specifies the unique identifier assigned by the vendor for this Cluster. type: - string - 'null' x-go-name: IssuerId userId: description: Specifies the unique identifier assigned by the vendor for the user. type: - string - 'null' x-go-name: UserId vendor: description: Specifies the vendor providing the IdP service. type: - string - 'null' x-go-name: Vendor x-go-package: cohesity/iris/server/data/public ElastifileCluster: description: Specifies information about a Elastifile Cluster. type: object title: Elastifile Cluster. properties: enodeIpAddressVec: description: IP addresses of Elastifile nodes. type: - array - 'null' items: type: string x-go-name: ElastifileNodeIps loadBalancerVip: description: Specifies the load balancer VIP if present. type: - string - 'null' x-go-name: LoadBalancerVip name: description: Specifies name of a Elastifile Cluster type: - string - 'null' x-go-name: Name uuid: description: Specifies the UUID of a Elastifile Cluster. type: - string - 'null' x-go-name: Uuid version: description: Specifies the version of a Elastifile Cluster. type: - string - 'null' x-go-name: Version x-go-package: cohesity/iris/server/data/public 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 UserParameters: description: 'Specifies the settings used to create/add a new user or modify an existing user.' type: object title: User Request. properties: additionalGroupNames: description: 'Array of Additional Groups. Specifies the names of additional groups this User may belong to.' type: - array - 'null' items: type: string x-go-name: AdditionalGroupNames clusterIdentifiers: description: 'Specifies the list of clusters this user has access to. If this is not specified, access will be granted to all clusters.' type: - array - 'null' items: $ref: '#/components/schemas/ClusterIdentifier' x-go-name: ClusterIdentifiers description: description: Specifies a description about the user. type: - string - 'null' x-go-name: Description domain: description: 'Specifies the fully qualified domain name (FQDN) of an Active Directory or LOCAL for the default LOCAL domain on the Cohesity Cluster. A user is uniquely identified by combination of the username and the domain.' type: - string - 'null' x-go-name: Domain effectiveTimeMsecs: description: 'Specifies the epoch time in milliseconds when the user becomes effective. Until that time, the user cannot log in.' type: - integer - 'null' format: int64 x-go-name: EffectiveTimeMsecs emailAddress: description: Specifies the email address of the user. type: - string - 'null' x-go-name: Email expiredTimeMsecs: description: 'Specifies the epoch time in milliseconds when the user becomes expired. After that, the user cannot log in.' type: - integer - 'null' format: int64 x-go-name: ExpiredTimeMsecs password: description: Specifies the password of this user. type: - string - 'null' x-go-name: Password primaryGroupName: description: Specifies the name of the primary group of this User. type: - string - 'null' x-go-name: PrimaryGroupName privilegeIds: description: 'Array of Privileges. Specifies the Cohesity privileges from the roles. This will be populated based on the union of all privileges in roles. Type for unique privilege Id values. All below enum values specify a value for all uniquely defined privileges in Cohesity.' type: - array - 'null' items: type: string enum: - kPrincipalView - kPrincipalModify - kAppLaunch - kAppsManagement - kOrganizationView - kOrganizationModify - kOrganizationImpersonate - kCloneView - kCloneModify - kClusterView - kClusterModify - kClusterCreate - kClusterSupport - kClusterUpgrade - kClusterRemoteView - kClusterRemoteModify - kClusterExternalTargetView - kClusterExternalTargetModify - kClusterAudit - kAlertView - kAlertModify - kVlanView - kVlanModify - kHybridExtenderView - kHybridExtenderDownload - kAdLdapView - kAdLdapModify - kSchedulerView - kSchedulerModify - kProtectionView - kProtectionModify - kProtectionJobOperate - kProtectionSourceModify - kProtectionPolicyView - kProtectionPolicyModify - kRestoreView - kRestoreModify - kRestoreDownload - kRemoteRestore - kStorageView - kStorageModify - kStorageDomainView - kStorageDomainModify - kAnalyticsView - kAnalyticsModify - kReportsView - kMcmModify - kDataSecurity - kSmbBackup - kSmbRestore - kSmbTakeOwnership - kSmbAuditing - kMcmUnregister - kMcmUpgrade - kMcmModifySuperAdmin - kMcmViewSuperAdmin - kMcmModifyCohesityAdmin - kMcmViewCohesityAdmin - kObjectSearch - kFileDatalockExpiryTimeDecrease x-go-name: PrivilegeIds restricted: description: 'Whether the user is a restricted user. A restricted user can only view the objects he has permissions to.' type: - boolean - 'null' x-go-name: Restricted roles: description: 'Array of Roles. Specifies the Cohesity roles to associate with the user such as such as ''Admin'', ''Ops'' or ''View''. The Cohesity roles determine privileges on the Cohesity Cluster for this user.' type: - array - 'null' items: type: string x-go-name: Roles username: description: Specifies the login name of the user. type: - string - 'null' x-go-name: Username 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 PureProtectionSource: description: Specifies a Protection Source in a Pure environment. type: object title: Pure Protection Source. properties: name: description: Specifies a unique name of the Protection Source type: - string - 'null' x-go-name: Name storageArray: description: 'Specifies a SAN Storage Array information. This is set only when the type is kStorageArray.' $ref: '#/components/schemas/SanStorageArray' type: description: 'Specifies the type of managed Object in a SAN/Pure Protection Source like a kStorageArray or kVolume. Examples of SAN Objects include ''kStorageArray'' and ''kVolume''. ''kStorageArray'' indicates that entire SAN storage array is being protected. ''kVolume'' indicates that volume within the array is being protected.' type: - string - 'null' enum: - kStorageArray - kVolume x-go-name: Type volume: description: 'Specifies a SAN Volume information within a storage array. This is set only when the type is kVolume.' $ref: '#/components/schemas/SanVolume' x-go-package: cohesity/iris/server/data/public RequestError: description: Details about the Error. type: object title: Error properties: errorCode: description: Operation response error code. type: - integer - 'null' format: int64 x-go-name: ErrorCode message: description: Description of the error. type: - string - 'null' x-go-name: Message x-go-package: cohesity/iris/server/data/public Office365ProtectionSource: description: Specifies a Protection Source in Office 365 environment. type: object title: Office 365 Protection Source. properties: description: description: Specifies the description of the Office 365 entity. type: - string - 'null' x-go-name: Description name: description: Specifies the name of the office 365 entity. type: - string - 'null' x-go-name: Name primarySMTPAddress: description: Specifies the SMTP address for the Outlook source. type: - string - 'null' x-go-name: PrimarySMTPAddress type: description: 'Specifies the type of the Office 365 entity. Specifies the type of Office 365 entity ''kDomain'' indicates the O365 domain through which authentication occurs. ''kOutlook'' indicates the Exchange online entities. ''kMailbox'' indicates the user''s mailbox account. ''kUsers'' indicates the container for User entities. ''kGroups'' indicates the container for Group entities. ''kSites'' indicates the container for Site entities. ''kUser'' indicates an Office365 User entity. ''kGroup'' indicates an Office365 Group entity. ''kSite'' indicates an Office365 SharePoint Site entity.' type: - string - 'null' enum: - kDomain - kOutlook - kMailbox - kUsers - kGroups - kSites - kUser - kGroup - kSite x-go-name: Type userInfo: description: 'Specifies the information about Office365 user regarding its Mailbox & OneDrive. This is only present if the entity type is a User.' $ref: '#/components/schemas/Office365UserInfo' uuid: description: Specifies the UUID of the Office 365 entity. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public 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 MongoDBConnectParams: description: 'Specifies an Object containing information about a registered mongodb source.' type: object title: MongoDB Connect Params. properties: authType: description: 'Specifies whether authentication is configured on this MongoDB cluster. Specifies the type of an MongoDB source entity. ''SCRAM'' ''LDAP'' ''NONE''' type: - string - 'null' enum: - SCRAM - LDAP - NONE x-go-name: AuthType authenticatingDatabaseName: description: Specifies the Authenticating Database for this MongoDB cluster. type: - string - 'null' x-go-name: AuthenticatingDatabaseName requiresSsl: description: Specifies whether connection is allowed through SSL only in this cluster. type: - boolean - 'null' x-go-name: RequiresSsl secondaryNodeTag: description: 'MongoDB Secondary node tag. Required only if ''useSecondaryForBackup'' is true. The system will use this to identify the secondary nodes for reading backup data.' type: - string - 'null' x-go-name: SecondaryNodeTag seeds: description: Specifies the seeds of this MongoDB Cluster. type: - array - 'null' items: type: string x-go-name: Seeds useSecondaryForBackup: description: Set this to true if you want the system to peform backups from secondary nodes. type: - boolean - 'null' x-go-name: UseSecondaryForBackup x-go-package: cohesity/iris/server/data/public ExchangeDatabaseCopyInfo: description: 'Specifies the information about the copy of the Exchange Database on particular Exchange Application Server that is part of DAG.' type: object title: Exchange Database Copy Information properties: activationPreferenceNumber: description: 'Specifies the activation preference number assigned for this database copy.' type: - integer - 'null' format: uint32 x-go-name: ActivationPreferenceNumber appServerId: description: 'Specifies the entity id of the Exchange Application Server which has this database copy.' type: - integer - 'null' format: int64 x-go-name: AppServerId backupSupported: description: Specifies if backup is supported for the Exchange database copy. type: - boolean - 'null' x-go-name: BackupSupported backupUnsupportedReasons: description: Specifies any reason(s) for Exchange database backup not supported. type: - array - 'null' items: type: string x-go-name: BackupUnsupportedReasons copyGuid: description: Specifies the Guid of the Exchange Database Copy. type: - string - 'null' x-go-name: CopyGuid createdTimeMsecs: description: 'Specifies the time when the database is created in Unix epoch time in milliseconds.' type: - integer - 'null' format: int64 x-go-name: CreatedTimeMsecs databaseState: description: 'Specifies the state of the Exchange database copy. Specifies the state of Exchange Database Copy. ''kUnknown'' indicates the status is not known. ''kMounted'' indicates the exchange database copy is mounted and healthy. ''kError'' indicates the exchange database copy is unmounted or partially mounted or is in error state.' type: - string - 'null' enum: - kUnknown - kMounted - kError x-go-name: DatabaseState dbSizeBytes: description: Specifies the size of the Exchange database copy in bytes. type: - integer - 'null' format: int64 x-go-name: DbSizeBytes dbguid: description: Specifies the guid of the Exchange Database. type: - string - 'null' x-go-name: DbGuid fqdn: description: 'Specifies the fully qualified domain name of the Exchange Server on which the database copy is hosted.' type: - string - 'null' x-go-name: Fqdn isActiveCopy: description: 'Specifies if the Exchange database copy present on the Exchange Application server is active or passive.' type: - boolean - 'null' x-go-name: ActiveCopy name: description: Specifes the name of the Exchange Database. type: - string - 'null' x-go-name: Name ownerId: description: 'Specifies the owner entity id of the Exchange Application Server which has this database copy.' type: - integer - 'null' format: int64 x-go-name: OwnerId serverName: description: 'Specifies the display name of the Exchange Application Server on which the database copy is hosted.' type: - string - 'null' x-go-name: ServerName utcOffsetMin: description: Specifies UTC time offset of database creation time. type: - integer - 'null' format: int64 x-go-name: UtcOffsetMin x-go-package: cohesity/iris/server/data/public GpfsFilesystem: description: Specifies information about filesystem in a GPFS Cluster. type: object title: GPFS Filesystem. properties: id: description: Specifies the id of the file system. type: - string - 'null' x-go-name: Id path: description: Specifies the path of the file system. type: - string - 'null' x-go-name: Path x-go-package: cohesity/iris/server/data/public Office365Credentials: description: Specifies the credentials to authenticate with Office365 account. type: object title: Office365 Credentials. properties: clientId: description: 'Specifies the application ID that the registration portal (apps.dev.microsoft.com) assigned.' type: - string - 'null' x-go-name: ClientId clientSecret: description: 'Specifies the application secret that was created in app registration portal.' type: - string - 'null' x-go-name: ClientSecret grantType: description: 'Specifies the application grant type. eg: For client credentials flow, set this to "client_credentials"; For refreshing access-token, set this to "refresh_token".' type: - string - 'null' x-go-name: GrantType scope: description: 'Specifies a space separated list of scopes/permissions for the user. eg: Incase of MS Graph APIs for Office365, scope is set to default: https://graph.microsoft.com/.default' type: - string - 'null' x-go-name: Scope useOAuthForExchangeOnline: description: 'This field is deprecated from here and placed in RegisteredSourceInfo and ProtectionSourceParameters. deprecated: true' type: - boolean - 'null' x-go-name: UseOAuthForExchangeOnline x-go-package: cohesity/iris/server/data/public NimbleProtectionSource: description: Specifies a Protection Source in a Nimble environment. type: object title: Nimble Protection Source. properties: name: description: Specifies a unique name of the Protection Source type: - string - 'null' x-go-name: Name storageArray: description: 'Specifies a SAN Storage Array information. This is set only when the type is kStorageArray.' $ref: '#/components/schemas/SanStorageArray' type: description: 'Specifies the type of managed Object in a SAN/Nimble Protection Source like a kStorageArray or kVolume. Examples of SAN Objects include ''kStorageArray'' and ''kVolume''. ''kStorageArray'' indicates that entire SAN storage array is being protected. ''kVolume'' indicates that volume within the array is being protected.' type: - string - 'null' enum: - kStorageArray - kVolume x-go-name: Type volume: description: 'Specifies a SAN Volume information within a storage array. This is set only when the type is kVolume.' $ref: '#/components/schemas/SanVolume' x-go-package: cohesity/iris/server/data/public HdfsProtectionSource: description: Specifies an Object representing Hdfs. type: object title: Hdfs Protection Source. properties: name: description: Specifies the instance name of the Hdfs entity. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of the managed Object in Hdfs Protection Source. Specifies the type of an Hdfs source entity. ''kCluster'' indicates a Hdfs cluster distributed over several physical nodes.' type: - string - 'null' enum: - kCluster x-go-name: Type uuid: description: Specifies the UUID for the Hdfs entity. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public FlashBladeNetworkInterface: description: Specifies network interface detail of a Flash Blade Storage Array. type: object title: Flash Blade Network Interface. properties: ipAddress: description: Specifies the IP address of the Pure Storage FlashBlade Array. type: - string - 'null' x-go-name: IpAddress name: description: Specifies the name of the network interface. type: - string - 'null' x-go-name: Name vlan: description: Specifies the id of the VLAN network of the Pure Storage FlashBlade Array. type: - integer - 'null' format: int32 x-go-name: Vlan x-go-package: cohesity/iris/server/data/public 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 ResetS3SecretKeyParameters: description: 'Specifies the parameters required to reset the S3 secret access key for the specified Cohesity user.' type: object title: Reset S3 Secret Access Key. properties: domain: description: 'Specifies the fully qualified domain name (FQDN) of an Active Directory or LOCAL for the default LOCAL domain on the Cohesity Cluster. If not specified, it is assumed to be LOCAL.' type: - string - 'null' x-go-name: Domain tenantId: description: Specifies the tenant for which the users are to be deleted. type: - string - 'null' x-go-name: TenantId username: description: Specifies the Cohesity user. type: - string - 'null' x-go-name: Username x-go-package: cohesity/iris/server/data/public User: description: Specifies details about a user. type: object title: User Details. properties: additionalGroupNames: description: 'Array of Additional Groups. Specifies the names of additional groups this User may belong to.' type: - array - 'null' items: type: string x-go-name: AdditionalGroupNames authenticationType: description: 'Specifies the authentication type of the user. ''kAuthLocal'' implies authenticated user is a local user. ''kAuthAd'' implies authenticated user is an Active Directory user. ''kAuthSalesforce'' implies authenticated user is a Salesforce user. ''kAuthGoogle'' implies authenticated user is a Google user. ''kAuthSso'' implies authenticated user is an SSO user.' type: - string - 'null' enum: - kAuthLocal - kAuthAd - kAuthSalesforce - kAuthGoogle - kAuthSso x-go-name: AuthenticationType clusterIdentifiers: description: 'Specifies the list of clusters this user has access to. If this is not specified, access will be granted to all clusters.' type: - array - 'null' items: $ref: '#/components/schemas/ClusterIdentifier' x-go-name: ClusterIdentifiers createdTimeMsecs: description: 'Specifies the epoch time in milliseconds when the user account was created on the Cohesity Cluster.' type: - integer - 'null' format: int64 x-go-name: CreatedTimeMsecs description: description: Specifies a description about the user. type: - string - 'null' x-go-name: Description domain: description: 'Specifies the fully qualified domain name (FQDN) of an Active Directory or LOCAL for the default LOCAL domain on the Cohesity Cluster. A user is uniquely identified by combination of the username and the domain.' type: - string - 'null' x-go-name: Domain effectiveTimeMsecs: description: 'Specifies the epoch time in milliseconds when the user becomes effective. Until that time, the user cannot log in.' type: - integer - 'null' format: int64 x-go-name: EffectiveTimeMsecs emailAddress: description: Specifies the email address of the user. type: - string - 'null' x-go-name: Email expiredTimeMsecs: description: 'Specifies the epoch time in milliseconds when the user becomes expired. After that, the user cannot log in.' type: - integer - 'null' format: int64 x-go-name: ExpiredTimeMsecs forcePasswordChange: description: Specifies whether to force user to change password. type: - boolean - 'null' x-go-name: ForcePasswordChange googleAccount: description: 'Specifies additional information pertaining to Google account. This field is set only for Helios BaaS users who has account on Google.' $ref: '#/components/schemas/GoogleAccountInfo' groupRoles: description: 'Specifies the Cohesity roles to associate with the user'' group. These roles can only be edited from group.' type: - array - 'null' items: type: string x-go-name: GroupRoles readOnly: true idpUserInfo: description: 'Specifies additional information pertaining to an IdP user. This field is set only for IdP users who has logged in via IdP.' $ref: '#/components/schemas/IdpUserInfo' lastUpdatedTimeMsecs: description: 'Specifies the epoch time in milliseconds when the user account was last modified on the Cohesity Cluster.' type: - integer - 'null' format: int64 x-go-name: LastUpdatedTimeMsecs orgMembership: description: 'OrgMembership contains the list of all available tenantIds for this user to switch to. Only when creating the session user, this field is populated on the fly. We discover the tenantIds from various groups assigned to the users.' type: - array - 'null' items: $ref: '#/components/schemas/TenantConfig' x-go-name: OrgMembership password: description: Specifies the password of this user. type: - string - 'null' x-go-name: Password preferences: description: Specifies preferences of the user. $ref: '#/components/schemas/Preferences' primaryGroupName: description: Specifies the name of the primary group of this User. type: - string - 'null' x-go-name: PrimaryGroupName privilegeIds: description: 'Array of Privileges. Specifies the Cohesity privileges from the roles. This will be populated based on the union of all privileges in roles. Type for unique privilege Id values. All below enum values specify a value for all uniquely defined privileges in Cohesity.' type: - array - 'null' items: type: string enum: - kPrincipalView - kPrincipalModify - kAppLaunch - kAppsManagement - kOrganizationView - kOrganizationModify - kOrganizationImpersonate - kCloneView - kCloneModify - kClusterView - kClusterModify - kClusterCreate - kClusterSupport - kClusterUpgrade - kClusterRemoteView - kClusterRemoteModify - kClusterExternalTargetView - kClusterExternalTargetModify - kClusterAudit - kAlertView - kAlertModify - kVlanView - kVlanModify - kHybridExtenderView - kHybridExtenderDownload - kAdLdapView - kAdLdapModify - kSchedulerView - kSchedulerModify - kProtectionView - kProtectionModify - kProtectionJobOperate - kProtectionSourceModify - kProtectionPolicyView - kProtectionPolicyModify - kRestoreView - kRestoreModify - kRestoreDownload - kRemoteRestore - kStorageView - kStorageModify - kStorageDomainView - kStorageDomainModify - kAnalyticsView - kAnalyticsModify - kReportsView - kMcmModify - kDataSecurity - kSmbBackup - kSmbRestore - kSmbTakeOwnership - kSmbAuditing - kMcmUnregister - kMcmUpgrade - kMcmModifySuperAdmin - kMcmViewSuperAdmin - kMcmModifyCohesityAdmin - kMcmViewCohesityAdmin - kObjectSearch - kFileDatalockExpiryTimeDecrease x-go-name: PrivilegeIds restricted: description: 'Whether the user is a restricted user. A restricted user can only view the objects he has permissions to.' type: - boolean - 'null' x-go-name: Restricted roles: description: 'Array of Roles. Specifies the Cohesity roles to associate with the user such as such as ''Admin'', ''Ops'' or ''View''. The Cohesity roles determine privileges on the Cohesity Cluster for this user.' type: - array - 'null' items: type: string x-go-name: Roles s3AccessKeyId: description: Specifies the S3 Account Access Key ID. type: - string - 'null' x-go-name: S3AccessKeyId s3AccountId: description: Specifies the S3 Account Canonical User ID. type: - string - 'null' x-go-name: S3AccountId s3SecretKey: description: Specifies the S3 Account Secret Key. type: - string - 'null' x-go-name: S3SecretKey salesforceAccount: description: 'Specifies additional information pertaining to Salesforce account. This field is set only for Helios users who has account on Salesforce.' $ref: '#/components/schemas/SalesforceAccountInfo' sid: description: 'Specifies the unique Security ID (SID) of the user. This field is mandatory in modifying user.' type: - string - 'null' x-go-name: Sid tenantId: description: Specifies the effective Tenant ID of the user. type: - string - 'null' x-go-name: TenantId username: description: Specifies the login name of the user. type: - string - 'null' x-go-name: Username x-go-package: cohesity/iris/server/data/public SalesforceAccountInfo: description: Salesforce Account Information of a Helios user. type: object title: Salesforce Account Information. properties: accountId: description: Specifies the Account Id assigned by Salesforce. type: - string - 'null' x-go-name: AccountId userId: description: Specifies the User Id assigned by Salesforce. type: - string - 'null' x-go-name: UserId x-go-package: cohesity/iris/server/data/public QuotaPolicy: description: 'Specifies a quota limit that can be optionally applied to Views and View Boxes. At the View level, this quota defines a logical limit for usage on the View. At the View Box level, this quota defines a physical limit or a default logical View limit. If a physical quota is specified for View Box, this quota defines a physical limit for the usage on the View Box. If a default logical View quota is specified for View Box, this limit is inherited by all the Views in that View Box. However, this inherited quota can be overwritten at the View level. A new write is not allowed if the resource will exceed the specified quota. However, it takes time for the Cohesity Cluster to calculate the usage across Nodes, so the limit may be exceeded by a small amount. In addition, if the limit is increased or data is removed, there may be a delay before the Cohesity Cluster allows more data to be written to the resource, as the Cluster calculates the usage across Nodes.' type: object title: Quota Policy properties: alertLimitBytes: description: 'Specifies if an alert should be triggered when the usage of this resource exceeds this quota limit. This limit is optional and is specified in bytes. If no value is specified, there is no limit.' type: - integer - 'null' format: int64 x-go-name: AlertLimitBytes alertThresholdPercentage: description: 'Supported only for user quota policy. Specifies when the usage goes above an alert threshold percentage which is: HardLimitBytes * AlertThresholdPercentage, eg: 80% of HardLimitBytes Can only be set if HardLimitBytes is set. Cannot be set if AlertLimitBytes is already set.' type: - integer - 'null' format: int64 x-go-name: AlertThresholdPercentage hardLimitBytes: description: 'Specifies an optional quota limit on the usage allowed for this resource. This limit is specified in bytes. If no value is specified, there is no limit.' type: - integer - 'null' format: int64 x-go-name: HardLimitBytes x-go-package: cohesity/iris/server/data/public NewS3SecretAccessKey: type: object properties: newKey: description: Specifies the new S3 Secret Access key. type: - string - 'null' x-go-name: NewKey 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 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 View: description: 'Specifies settings for defining a storage location (called a View) with NFS and SMB mount paths in a Storage Domain (View Box) on the Cohesity Cluster.' type: object title: View. properties: accessSids: description: 'Array of Security Identifiers (SIDs) Specifies the list of security identifiers (SIDs) for the restricted Principals who have access to this View.' type: - array - 'null' items: type: string x-go-name: AccessSids aliases: description: 'Aliases created for the view. A view alias allows a directory path inside a view to be mounted using the alias name.' type: - array - 'null' items: $ref: '#/components/schemas/ViewAlias' x-go-name: Aliases allSmbMountPaths: description: 'Array of SMB Paths. Specifies the possible paths that can be used to mount this View as a SMB share. If Active Directory has multiple account names; each machine account has its own path.' type: - array - 'null' items: type: string x-go-name: AllSmbMountPaths antivirusScanConfig: description: Specifies the antivirus scan config settings for this View. $ref: '#/components/schemas/AntivirusScanConfig' basicMountPath: description: 'Specifies the NFS mount path of the View (without the hostname information). This path is used to support NFS mounting of the paths specified in the nfsExportPathList on Windows systems.' type: - string - 'null' x-go-name: BasicMountPath caseInsensitiveNamesEnabled: description: 'Specifies whether to support case insensitive file/folder names. This parameter can only be set during create and cannot be changed.' type: - boolean - 'null' x-go-name: CaseInsensitiveNamesEnabled createTimeMsecs: description: Specifies the time that the View was created in milliseconds. type: - integer - 'null' format: int64 x-go-name: CreateTimeMsecs dataLockExpiryUsecs: description: 'DataLock (Write Once Read Many) lock expiry epoch time in microseconds. If a view is marked as a DataLock view, only a Data Security Officer (a user having Data Security Privilege) can delete the view until the lock expiry time.' type: - integer - 'null' format: int64 x-go-name: DataLockExpiryUsecs description: description: Specifies an optional text description about the View. type: - string - 'null' x-go-name: Description enableFastDurableHandle: description: 'Specifies whether fast durable handle is enabled. If enabled, view open handle will be kept in memory, which results in a higher performance. But the handles cannot be recovered if node or service crashes.' type: - boolean - 'null' x-go-name: EnableFastDurableHandle enableFilerAuditLogging: description: Specifies if Filer Audit Logging is enabled for this view. type: - boolean - 'null' x-go-name: EnableFilerAuditLogging enableLiveIndexing: description: Specifies whether to enable live indexing for the view. type: - boolean - 'null' x-go-name: EnableLiveIndexing enableMixedModePermissions: description: 'If set, mixed mode (NFS and SMB) access is enabled for this view. This field is deprecated. Use the field SecurityMode. deprecated: true' type: - boolean - 'null' x-go-name: EnableMixedModePermissions enableNfsViewDiscovery: description: If set, it enables discovery of view for NFS. type: - boolean - 'null' x-go-name: EnableNfsViewDiscovery enableOfflineCaching: description: Specifies whether to enable offline file caching of the view. type: - boolean - 'null' x-go-name: EnableOfflineCaching enableSmbAccessBasedEnumeration: description: 'Specifies if access-based enumeration should be enabled. If ''true'', only files and folders that the user has permissions to access are visible on the SMB share for that user.' type: - boolean - 'null' x-go-name: EnableSmbAccessBasedEnumeration enableSmbEncryption: description: 'Specifies the SMB encryption for the View. If set, it enables the SMB encryption for the View. Encryption is supported only by SMB 3.x dialects. Dialects that do not support would still access data in unencrypted format.' type: - boolean - 'null' x-go-name: EnableSmbEncryption enableSmbOplock: description: Specifies whether SMB opportunistic lock is enabled. type: - boolean - 'null' x-go-name: EnableSmbOplock enableSmbViewDiscovery: description: If set, it enables discovery of view for SMB. type: - boolean - 'null' x-go-name: EnableSmbViewDiscovery enforceSmbEncryption: description: 'Specifies the SMB encryption for all the sessions for the View. If set, encryption is enforced for all the sessions for the View. When enabled all future and existing unencrypted sessions are disallowed.' type: - boolean - 'null' x-go-name: EnforceSmbEncryption fileExtensionFilter: description: 'Optional filtering criteria that should be satisfied by all the files created in this view. It does not affect existing files.' $ref: '#/components/schemas/FileExtensionFilter' fileLockConfig: description: 'Optional config that enables file locking for this view. It cannot be disabled during the edit of a view, if it has been enabled during the creation of the view. Also, it cannot be enabled if it was disabled during the creation of the view.' $ref: '#/components/schemas/FileLevelDataLockConfig' isTargetForMigratedData: description: Specifies if a view contains migrated data. type: - boolean - 'null' x-go-name: IsTargetForMigratedData logicalQuota: description: 'Specifies an optional logical quota limit (in bytes) for the usage allowed on this View. (Logical data is when the data is fully hydrated and expanded.) This limit overrides the limit inherited from the Storage Domain (View Box) (if set). If logicalQuota is nil, the limit is inherited from the Storage Domain (View Box) (if set). A new write is not allowed if the Storage Domain (View Box) will exceed the specified quota. However, it takes time for the Cohesity Cluster to calculate the usage across Nodes, so the limit may be exceeded by a small amount. In addition, if the limit is increased or data is removed, there may be a delay before the Cohesity Cluster allows more data to be written to the View, as the Cluster is calculating the usage across Nodes.' allOf: - $ref: '#/components/schemas/QuotaPolicy' logicalUsageBytes: description: LogicalUsageBytes is the logical usage in bytes for the view. type: - integer - 'null' format: int64 x-go-name: LogicalUsageBytes name: description: Specifies the name of the View. type: - string - 'null' x-go-name: Name netgroupWhitelist: description: 'Array of Netgroups. Specifies a list of Netgroups that have permissions to access the View. (Overrides the Netgroups specified at the global Cohesity Cluster level.)' type: - array - 'null' items: $ref: '#/components/schemas/NisNetgroup' x-go-name: NetgroupWhitelist nfsAllSquash: description: Specifies the NFS all squash config. $ref: '#/components/schemas/NfsSquash' nfsMountPath: description: Specifies the path for mounting this View as an NFS share. type: - string - 'null' x-go-name: NfsMountPath nfsRootPermissions: description: Specifies the NFS root permission config of the view file system. $ref: '#/components/schemas/NfsRootPermissions' nfsRootSquash: description: Specifies the NFS root squash config. $ref: '#/components/schemas/NfsSquash' overrideGlobalNetgroupWhitelist: description: 'Specifies whether view level client netgroup whitelist overrides cluster and global setting.' type: - boolean - 'null' x-go-name: OverrideGlobalNetgroupWhitelist overrideGlobalWhitelist: description: 'Specifies whether view level client subnet whitelist overrides cluster and global setting.' type: - boolean - 'null' x-go-name: OverrideGlobalWhitelist protocolAccess: description: 'Specifies the supported Protocols for the View. ''kAll'' enables protocol access to following three views: NFS, SMB and S3. ''kNFSOnly'' enables protocol access to NFS only. ''kSMBOnly'' enables protocol access to SMB only. ''kS3Only'' enables protocol access to S3 only. ''kSwiftOnly'' enables protocol access to Swift only.' type: - string - 'null' enum: - kAll - kNFSOnly - kSMBOnly - kS3Only - kSwiftOnly x-go-name: ProtocolAccess qos: description: Specifies the Quality of Service (QoS) Policy for the View. $ref: '#/components/schemas/QoS' s3AccessPath: description: Specifies the path to access this View as an S3 share. type: - string - 'null' x-go-name: S3AccessPath s3KeyMappingConfig: description: 'Specifies the S3 key mapping config of the view. This parameter can only be set during create and cannot be changed. Configuration of S3 key mapping. Specifies the type of S3 key mapping config.' type: - string - 'null' enum: - kRandom - kShort - kLong - kHierarchical x-go-name: S3KeyMappingConfig securityMode: description: 'Specifies the security mode used for this view. Currently we support the following modes: Native, Unified and NTFS style. ''kNativeMode'' indicates a native security mode. ''kUnifiedMode'' indicates a unified security mode. ''kNtfsMode'' indicates a NTFS style security mode.' type: - string - 'null' enum: - kNativeMode - kUnifiedMode - kNtfsMode x-go-name: SecurityMode sharePermissions: description: Specifies a list of share level permissions. type: - array - 'null' items: $ref: '#/components/schemas/SmbPermission' x-go-name: SharePermissions smbMountPath: description: Specifies the main path for mounting this View as an SMB share. type: - string - 'null' x-go-name: SmbMountPath smbPermissionsInfo: description: Specifies the SMB permissions for the View. $ref: '#/components/schemas/SmbPermissionsInfo' stats: description: 'Specifies statistics about the View. readOnly: true' $ref: '#/components/schemas/ViewStats' storagePolicyOverride: description: 'Specifies if inline deduplication and compression settings inherited from the Storage Domain (View Box) should be disabled for this View.' $ref: '#/components/schemas/StoragePolicyOverride' subnetWhitelist: description: 'Array of Subnets. Specifies a list of Subnets with IP addresses that have permissions to access the View. (Overrides the Subnets specified at the global Cohesity Cluster level.)' type: - array - 'null' items: $ref: '#/components/schemas/Subnet' x-go-name: SubnetWhitelist swiftProjectDomain: description: Specifies the Keystone project domain. type: - string - 'null' x-go-name: SwiftProjectDomain swiftProjectName: description: Specifies the Keystone project name. type: - string - 'null' x-go-name: SwiftProjectName swiftUserDomain: description: Specifies the Keystone user domain. type: - string - 'null' x-go-name: SwiftUserDomain swiftUsername: description: Specifies the Keystone username. type: - string - 'null' x-go-name: SwiftUsername tenantId: description: Optional tenant id who has access to this View. type: - string - 'null' x-go-name: TenantId viewBoxId: description: Specifies the id of the Storage Domain (View Box) where the View is stored. type: - integer - 'null' format: int64 x-go-name: ViewBoxId viewBoxName: description: Specifies the name of the Storage Domain (View Box) where the View is stored. type: - string - 'null' x-go-name: ViewBoxName viewId: description: Specifies an id of the View assigned by the Cohesity Cluster. type: - integer - 'null' format: int64 x-go-name: ViewId viewLockEnabled: description: 'Specifies whether view lock is enabled. If enabled the view cannot be modified or deleted until unlock. By default it is disabled.' type: - boolean - 'null' x-go-name: ViewLockEnabled viewProtection: description: Specifies information about the Protection Jobs protecting this View. $ref: '#/components/schemas/ViewProtection' x-go-package: cohesity/iris/server/data/public CassandraProtectionSource: description: Specifies an Object representing Cassandra. type: object title: Cassandra Protection Source. properties: clusterInfo: description: 'Information of a Cassandra cluster, only valid for an entity of type kCluster.' $ref: '#/components/schemas/CassandraCluster' keyspaceInfo: description: 'Information of a cassandra keyspapce, only valid for an entity of type kKeyspace.' $ref: '#/components/schemas/CassandraKeyspace' name: description: Specifies the instance name of the Cassandra entity. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of the managed Object in Cassandra Protection Source. Replication strategy options for a keyspace. ''kCluster'' indicates a Cassandra cluster distributed over several physical nodes. ''kKeyspace'' indicates a Keyspace enclosing one or more tables. ''kTable'' indicates a Table in the Cassandra environment.' type: - string - 'null' enum: - kCluster - kKeyspace - kTable x-go-name: Type uuid: description: 'Specifies the UUID for the Cassandra entity. Note : For each entity an ID unique within top level entity should be assigned by imanis backend. Example, UUID for a table can be the string .' type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public QoS: description: Specifies the Quality of Service (QoS) Policy for the View. type: object title: QoS. properties: principalId: description: Specifies the name of the QoS Policy used for the View. type: - integer - 'null' format: int64 x-go-name: PrincipalId principalName: description: 'Specifies the name of the QoS Policy used for the View such as ''TestAndDev High'', ''Backup Target SSD'', ''Backup Target High'' ''TestAndDev Low'' and ''Backup Target Low''. For a complete list and descriptions, see the ''Create or Edit Views'' topic in the documentation. If not specified, the default is ''Backup Target Low''.' type: - string - 'null' x-go-name: PrincipalName x-go-package: cohesity/iris/server/data/public UserDeleteParameters: description: Specifies the users to delete on the Cohesity Cluster. type: object title: Delete Users Request. properties: domain: description: 'Specifies the domain associated with the users to delete. Only users associated with the same domain can be deleted by a single request. If no domain is specified, the specified users are deleted from the LOCAL domain on the Cohesity Cluster. If a non-LOCAL domain is specified, the specified users are deleted on the Cohesity Cluster. However, the referenced user principals on the Active Directory are not deleted.' type: - string - 'null' x-go-name: Domain tenantId: description: Specifies the tenant for which the users are to be deleted. type: - string - 'null' x-go-name: TenantId users: description: 'Array of Users. Specifies the list of users to delete on Cohesity Cluster. Only users from the same domain can be deleted by a single request.' type: - array - 'null' items: type: string x-go-name: Usernames 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 GoogleAccountInfo: description: Google Account Information of a Helios BaaS user. type: object title: Google Account Information. properties: accountId: description: Specifies the Account Id assigned by Google. type: - string - 'null' x-go-name: AccountId userId: description: Specifies the User Id assigned by Google. type: - string - 'null' x-go-name: UserId x-go-package: cohesity/iris/server/data/public IsilonCluster: description: Specifies information about an Isilon Cluster. type: object title: Isilon Cluster. properties: apiVersionStr: description: Specifies the API version of an Isilon Cluster as string. type: - string - 'null' x-go-name: ApiVersionStr description: description: Specifies the description of an Isilon Cluster. type: - string - 'null' x-go-name: Description guid: description: Specifies a globally unique id of an Isilon Cluster. type: - string - 'null' x-go-name: Guid version: description: Specifies the version of an Isilon Cluster. type: - string - 'null' x-go-name: Version x-go-package: cohesity/iris/server/data/public CassandraSecurityInfo: description: Specifies an Object containing information on Cassandra security. type: object title: CassandraSecurityInfo Cassandra security info. properties: cassandraAuthRequired: description: Is Cassandra authentication required ? type: - boolean - 'null' x-go-name: CassandraAuthRequired cassandraAuthType: description: 'Cassandra Authentication type. Enum: [PASSWORD KERBEROS LDAP] Specifies the Cassandra auth type. ''PASSWORD'' ''KERBEROS'' ''LDAP''' type: - string - 'null' enum: - PASSWORD - KERBEROS - LDAP x-go-name: CassandraAuthType cassandraAuthorizer: description: Cassandra Authenticator/Authorizer. type: - string - 'null' x-go-name: CassandraAuthorizer clientEncryption: description: Is Client Encryption enabled for this cluster ? type: - boolean - 'null' x-go-name: ClientEncryption dseAuthorization: description: Is DSE Authorization enabled for this cluster ? type: - boolean - 'null' x-go-name: DseAuthorization serverEncryptionReqClientAuth: description: Is 'Server encryption request client authentication' enabled for this cluster ? type: - boolean - 'null' x-go-name: ServerEncryptionReqClientAuth serverInternodeEncryptionType: description: '''Server internal node Encryption'' type for this cluster.' type: - string - 'null' x-go-name: ServerInternodeEncryptionType x-go-package: cohesity/iris/server/data/public AgentInformation: description: 'Specifies information about the Agent software running on the server or the Virtual Machine.' type: object title: Agent Information. properties: cbmrVersion: description: Specifies the version if Cristie BMR product is installed on the host. type: - string - 'null' x-go-name: CbmrVersion hostType: description: 'Specifies the host type where the agent is running. This is only set for persistent agents. ''kLinux'' indicates the Linux operating system. ''kWindows'' indicates the Microsoft Windows operating system. ''kAix'' indicates the IBM AIX operating system. ''kSolaris'' indicates the Oracle Solaris operating system. ''kSapHana'' indicates the Sap Hana database system developed by SAP SE. ''kOther'' indicates the other types of operating system.' type: - string - 'null' enum: - kLinux - kWindows - kAix - kSolaris - kSapHana - kOther x-go-name: HostType id: description: Specifies the agent's id. type: - integer - 'null' format: int64 x-go-name: Id name: description: Specifies the agent's name. type: - string - 'null' x-go-name: Name oracleMultiNodeChannelSupported: description: Specifies whether oracle multi node multi channel is supported or not. type: - boolean - 'null' x-go-name: OracleMultiNodeChannelSupported registrationInfo: description: Specifies registration information for an Agent. $ref: '#/components/schemas/RegisteredSourceInfo' sourceSideDedupEnabled: description: Specifies whether source side dedup is enabled or not. type: - boolean - 'null' x-go-name: SourceSideDedupEnabled status: description: 'Specifies the agent status. Specifies the status of the agent running on a physical source. ''kUnknown'' indicates the Agent is not known. No attempt to connect to the Agent has occurred. ''kUnreachable'' indicates the Agent is not reachable. ''kHealthy'' indicates the Agent is healthy. ''kDegraded'' indicates the Agent is running but in a degraded state.' type: - string - 'null' enum: - kUnknown - kUnreachable - kHealthy - kDegraded x-go-name: Status statusMessage: description: Specifies additional details about the agent status. type: - string - 'null' x-go-name: StatusMessage upgradability: description: 'Specifies the upgradability of the agent running on the physical server. Specifies the upgradability of the agent running on the physical server. ''kUpgradable'' indicates the Agent can be upgraded to the agent software version on the cluster. ''kCurrent'' indicates the Agent is running the latest version. ''kUnknown'' indicates the Agent''s version is not known. ''kNonUpgradableInvalidVersion'' indicates the Agent''s version is invalid. ''kNonUpgradableAgentIsNewer'' indicates the Agent''s version is newer than the agent software version the cluster. ''kNonUpgradableAgentIsOld'' indicates the Agent''s version is too old that does not support upgrades.' type: - string - 'null' enum: - kUpgradable - kCurrent - kUnknown - kNonUpgradableInvalidVersion - kNonUpgradableAgentIsNewer - kNonUpgradableAgentIsOld x-go-name: Upgradability upgradeStatus: description: 'Specifies the status of the upgrade of the agent on a physical server. Specifies the status of the upgrade of the agent on a physical server. ''kIdle'' indicates there is no agent upgrade in progress. ''kAccepted'' indicates the Agent upgrade is accepted. ''kStarted'' indicates the Agent upgrade is in progress. ''kFinished'' indicates the Agent upgrade is completed.' type: - string - 'null' enum: - kIdle - kAccepted - kStarted - kFinished x-go-name: UpgradeStatus upgradeStatusMessage: description: 'Specifies detailed message about the agent upgrade failure. This field is not set for successful upgrade.' type: - string - 'null' x-go-name: UpgradeStatusMessage version: description: Specifies the version of the Agent software. type: - string - 'null' x-go-name: Version x-go-package: cohesity/iris/server/data/public 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 NasMountCredentialParams: description: Specifies the credentials to mount a volume on a NetApp server. type: object title: NAS Mount Credentials. properties: domain: description: Specifies the domain in which this credential is valid. type: - string - 'null' x-go-name: Domain domainController: description: Specifies the domain controller for the selected domain type: - string - 'null' x-go-name: DomainController managePasswordByCohesity: description: Specifies if Cohesity can manage the password after registration type: - boolean - 'null' x-go-name: ManagePasswordByCohesity nasProtocol: description: 'Specifies the protocol used by the NAS server. Specifies the protocol used by a NAS server. ''kNfs3'' indicates NFS v3 protocol. ''kCifs1'' indicates CIFS v1.0 protocol.' type: - string - 'null' enum: - kNfs3 - kCifs1 x-go-name: NasProtocol nasType: description: 'Specifies the type of a NAS Object such as ''kGroup'', or ''kHost''. Specifies the kind of NAS mount. ''kGroup'' indicates top level node that holds individual NAS hosts. ''kHost'' indicates a single NAS path that can be mounted. ''kDfsGroup'' indicates a DFS group containing top level directories mapped to different servers. ''kDfsTopDir'' indicates a top level directory inside a DFS group, discovered when registering a DFS group.' type: - string - 'null' enum: - kGroup - kHost - kDfsGroup - kDfsTopDir x-go-name: NasType password: description: Specifies the password for the username to use for mounting the NAS. type: - string - 'null' x-go-name: Password skipValidation: description: 'Specifies the flag to disable mount point validation during registration process.' type: - boolean - 'null' x-go-name: SkipValidation username: description: Specifies a username to use for mounting the NAS. type: - string - 'null' x-go-name: Username x-go-package: cohesity/iris/server/data/public NetworkingInformation: description: 'Specifies the struct containing information about network addresses configured on the given box. This is needed for dealing with Windows/Oracle Cluster resources that we discover and protect automatically.' type: object title: Networking Information. properties: resourceVec: description: 'The list of resources on the system that are accessible by an IP address.' type: - array - 'null' items: $ref: '#/components/schemas/ClusterNetworkingResourceInformation' x-go-name: ResourceVec x-go-package: cohesity/iris/server/data/public VMwareObjectId: description: 'Specifies a unique Protection Source id across Cohesity Clusters. It is derived from the id of the VMware Protection Source.' type: object title: VMware Object Id. properties: morItem: description: Specifies the Managed Object Reference Item. type: - string - 'null' x-go-name: MorItem morType: description: Specifies the Managed Object Reference Type. type: - string - 'null' x-go-name: MorType uuid: description: Specifies a Universally Unique Identifier (UUID) of a VMware Object. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public NfsSquash: type: object title: NfsSquash specifies the squash config for client subnet whitelist. properties: gid: description: GID mapped for all clients. type: - integer - 'null' format: uint32 x-go-name: Gid uid: description: UID mapped for all clients. type: - integer - 'null' format: uint32 x-go-name: Uid x-go-package: cohesity/iris/server/data/public NetappVserverInfo: description: Specifies information about a NetApp Vserver in a NetApp Protection Source. type: object title: NetApp Vserver Information. properties: dataProtocols: description: 'Array of Data Protocols. Specifies the set of data protocols supported by this Vserver. The kManagement protocol is not supported for this case. ''kNfs'' indicates NFS connections. ''kCifs'' indicates SMB (CIFS) connections. ''kIscsi'' indicates iSCSI connections. ''kFc'' indicates Fiber Channel connections. ''kFcache'' indicates Flex Cache connections. ''kHttp'' indicates HTTP connections. ''kNdmp'' indicates NDMP connections. ''kManagement'' indicates non-data connections used for management purposes. ''kNvme'' indicates NVMe connections.' type: - array - 'null' items: type: string enum: - kNfs - kCifs - kIscsi - kFc - kFcache - kHttp - kNdmp - kManagement - kNvme x-go-name: DataProtocols interfaces: description: 'Array of Interfaces. Specifies information about all interfaces on this Vserver.' type: - array - 'null' items: $ref: '#/components/schemas/VserverNetworkInterface' x-go-name: Interfaces rootCifsShare: description: 'Specifies the root ''c$'' CIFS share of this Vserver. If it exists, it can be used to mount all CIFS volumes that are junctioned under ''/'' on this Vserver.' $ref: '#/components/schemas/CifsShareInfo' type: description: 'Specifies the type of this Vserver. Specifies the type of the NetApp Vserver. ''kData'' indicates the Vserver is used for data backup and restore. ''kAdmin'' indicates the Vserver is used for cluster-wide management. ''kSystem'' indicates the Vserver is used for cluster-scoped communications in an IPspace. ''kNode'' indicates the Vserver is used as the physical controller. ''kUnknown'' indicates the Vserver is used for an unknown purpose.' type: - string - 'null' enum: - kData - kAdmin - kSystem - kNode - kUnknown x-go-name: Type x-go-package: cohesity/iris/server/data/public SanStorageArray: description: Specifies a SAN Storage Array. type: object title: SAN Storage Array. properties: id: description: 'Specifies a unique id of a SAN Storage Array. The id is unique across Cohesity Clusters.' type: - string - 'null' x-go-name: Id ports: description: Specifies the SAN ports of the SAN Storage Array. type: - array - 'null' items: $ref: '#/components/schemas/IscsiSanPort' x-go-name: Ports revision: description: Specifies the revision of the SAN Storage Array. type: - string - 'null' x-go-name: Revision version: description: Specifies the version of the SAN Storage Array. type: - string - 'null' x-go-name: Version x-go-package: cohesity/iris/server/data/public CouchbaseBucket: description: Specifies an Object containing information about a couchbase Bucket. type: object title: Couchbase Bucket Info. properties: bucketType: description: Type of this bucket. type: - string - 'null' x-go-name: BucketType documentCount: description: Number of documents in this bucket. type: - integer - 'null' format: int64 x-go-name: DocumentCount x-go-package: cohesity/iris/server/data/public IsilonSmbMountPoint: description: 'Specifies information specific to SMB shares exposed by Isilon file system.' type: object title: Isilon SMB Mount Point. properties: accessZoneId: description: Specifies the Access Zone Id. type: - integer - 'null' format: int64 x-go-name: AccessZoneId description: description: Specifies the description of the NFS mount point. type: - string - 'null' x-go-name: Description shareName: description: Specifies the name of the SMB/CIFS share. type: - string - 'null' x-go-name: ShareName x-go-package: cohesity/iris/server/data/public ViewProtectionSource: description: Specifies a Protection Source in a View environment. type: object title: View Protection Source. properties: id: description: 'Specifies a unique id of a Protection Source for a View. The id is unique across Cohesity Clusters.' allOf: - $ref: '#/components/schemas/UniversalId' name: description: Specifies a human readable name of the Protection Source of a View. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of managed Object in a View Protection Source environment. Examples of View Objects include ''kViewBox'' or ''kView''. ''kViewBox'' indicates Storage Domain as a Protection Source type. ''kView'' indicates View as a Protection Source type.' type: - string - 'null' enum: - kViewBox - kView x-go-name: Type x-go-package: cohesity/iris/server/data/public ProtectionSource: description: 'Specifies a generic structure that represents a node in the Protection Source tree. Node details will depend on the environment of the Protection Source.' type: object title: Protection Source. properties: acropolisProtectionSource: description: 'Specifies details about an Acropolis Protection Source when the environment is set to ''kAcropolis''.' allOf: - $ref: '#/components/schemas/AcropolisProtectionSource' adProtectionSource: description: 'Specifies details about an AD Protection Source when the environment is set to ''kAD''.' allOf: - $ref: '#/components/schemas/AdProtectionSource' awsProtectionSource: description: 'Specifies details about an AWS Protection Source when the environment is set to ''kAWS''.' allOf: - $ref: '#/components/schemas/AwsProtectionSource' azureProtectionSource: description: 'Specifies details about an Azure Protection Source when the environment is set to ''kAzure''.' allOf: - $ref: '#/components/schemas/AzureProtectionSource' cassandraProtectionSource: description: 'Specifies details about a Cassandra Protection Source when the environment is set to ''kCassandra''.' allOf: - $ref: '#/components/schemas/CassandraProtectionSource' couchbaseProtectionSource: description: 'Specifies details about a Couchbase Protection Source when the environment is set to ''kCouchbase''.' allOf: - $ref: '#/components/schemas/CouchbaseProtectionSource' elastifileProtectionSource: description: 'Specifies details about a Elastifile Protection Source when the environment is set to ''kElastifile''.' allOf: - $ref: '#/components/schemas/ElastifileProtectionSource' environment: description: 'Specifies the environment (such as ''kVMware'' or ''kSQL'') where the Protection Source exists. Depending on the environment, one of the following Protection Sources are initialized. NOTE: kPuppeteer refers to Cohesity''s Remote Adapter. Supported environment types such as ''kView'', ''kSQL'', ''kVMware'', etc. NOTE: ''kPuppeteer'' refers to Cohesity''s Remote Adapter. ''kVMware'' indicates the VMware Protection Source environment. ''kHyperV'' indicates the HyperV Protection Source environment. ''kSQL'' indicates the SQL Protection Source environment. ''kView'' indicates the View Protection Source environment. ''kPuppeteer'' indicates the Cohesity''s Remote Adapter. ''kPhysical'' indicates the physical Protection Source environment. ''kPure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''kAzure'' indicates the Microsoft''s Azure Protection Source environment. ''kNetapp'' indicates the Netapp Protection Source environment. ''kAgent'' indicates the Agent Protection Source environment. ''kGenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''kAcropolis'' indicates the Acropolis Protection Source environment. ''kPhsicalFiles'' indicates the Physical Files Protection Source environment. ''kIsilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''kGPFS'' indicates IBM''s GPFS Protection Source environment. ''kKVM'' indicates the KVM Protection Source environment. ''kAWS'' indicates the AWS Protection Source environment. ''kExchange'' indicates the Exchange Protection Source environment. ''kHyperVVSS'' indicates the HyperV VSS Protection Source environment. ''kOracle'' indicates the Oracle Protection Source environment. ''kGCP'' indicates the Google Cloud Platform Protection Source environment. ''kFlashBlade'' indicates the Flash Blade Protection Source environment. ''kAWSNative'' indicates the AWS Native Protection Source environment. ''kO365'' indicates the Office 365 Protection Source environment. ''kO365Outlook'' indicates Office 365 outlook Protection Source environment. ''kHyperFlex'' indicates the Hyper Flex Protection Source environment. ''kGCPNative'' indicates the GCP Native Protection Source environment. ''kAzureNative'' indicates the Azure Native Protection Source environment. ''kKubernetes'' indicates a Kubernetes Protection Source environment. ''kElastifile'' indicates Elastifile Protection Source environment. ''kAD'' indicates Active Directory Protection Source environment. ''kRDSSnapshotManager'' indicates AWS RDS Protection Source environment. ''kCassandra'' indicates Cassandra Protection Source environment. ''kMongoDB'' indicates MongoDB Protection Source environment. ''kCouchbase'' indicates Couchbase Protection Source environment. ''kHdfs'' indicates Hdfs Protection Source environment. ''kHive'' indicates Hive Protection Source environment. ''kHBase'' indicates HBase Protection Source environment.' type: - string - 'null' enum: - kVMware - kHyperV - kSQL - kView - kPuppeteer - kPhysical - kPure - kNimble - kAzure - kNetapp - kAgent - kGenericNas - kAcropolis - kPhysicalFiles - kIsilon - kGPFS - kKVM - kAWS - kExchange - kHyperVVSS - kOracle - kGCP - kFlashBlade - kAWSNative - kO365 - kO365Outlook - kHyperFlex - kGCPNative - kAzureNative - kKubernetes - kElastifile - kAD - kRDSSnapshotManager - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase x-go-name: Environment exchangeProtectionSource: description: 'Specifies details about an Exchange Protection Source when the environment is set to ''kExchange''.' allOf: - $ref: '#/components/schemas/ExchangeProtectionSource' flashBladeProtectionSource: description: 'Specifies details about a Pure Storage FlashBlade Protection Source when the environment is set to ''kFlashBlade''.' allOf: - $ref: '#/components/schemas/FlashBladeProtectionSource' gcpProtectionSource: description: 'Specifies details about an GCP Protection Source when the environment is set to ''kGCP''.' allOf: - $ref: '#/components/schemas/GcpProtectionSource' gpfsProtectionSource: description: 'Specifies details about an GPFS Protection Source when the environment is set to ''kGPFS''.' allOf: - $ref: '#/components/schemas/GpfsProtectionSource' hbaseProtectionSource: description: 'Specifies details about a HBase Protection Source when the environment is set to ''kHBase''.' allOf: - $ref: '#/components/schemas/HBaseProtectionSource' hdfsProtectionSource: description: 'Specifies details about a Hdfs Protection Source when the environment is set to ''kHdfs''.' allOf: - $ref: '#/components/schemas/HdfsProtectionSource' hiveProtectionSource: description: 'Specifies details about a Hive Protection Source when the environment is set to ''kHive''.' allOf: - $ref: '#/components/schemas/HiveProtectionSource' hyperFlexProtectionSource: description: 'Specifies details about a HyperFlex Storage Snapshot source when the environment is set to ''kHyperFlex''' allOf: - $ref: '#/components/schemas/HyperFlexProtectionSource' hypervProtectionSource: description: 'Specifies details about a HyperV Protection Source when the environment is set to ''kHyperV''.' allOf: - $ref: '#/components/schemas/HypervProtectionSource' id: description: Specifies an id of the Protection Source. type: - integer - 'null' format: int64 x-go-name: Id isilonProtectionSource: description: 'Specifies details about an Isilon OneFs Protection Source when the environment is set to ''kIsilon''.' allOf: - $ref: '#/components/schemas/IsilonProtectionSource' kubernetesProtectionSource: description: 'Specifies details about a Kubernetes Protection Source when the environment is set to ''kKubernetes''.' allOf: - $ref: '#/components/schemas/KubernetesProtectionSource' kvmProtectionSource: description: 'Specifies details about a KVM Protection Source when the environment is set to ''kKVM''.' allOf: - $ref: '#/components/schemas/KvmProtectionSource' mongodbProtectionSource: description: 'Specifies details about a MongoDB Protection Source when the environment is set to ''kMongoDB''.' allOf: - $ref: '#/components/schemas/MongoDBProtectionSource' name: description: Specifies a name of the Protection Source. type: - string - 'null' x-go-name: Name nasProtectionSource: description: 'Specifies details about a Generic NAS Protection Source when the environment is set to ''kGenericNas''.' allOf: - $ref: '#/components/schemas/NasProtectionSource' netappProtectionSource: description: 'Specifies details about a NetApp Protection Source when the environment is set to ''kNetapp''.' allOf: - $ref: '#/components/schemas/NetappProtectionSource' nimbleProtectionSource: description: 'Specifies details about a SAN Protection Source when the environment is set to ''kNimble''.' allOf: - $ref: '#/components/schemas/NimbleProtectionSource' office365ProtectionSource: description: 'Specifies details about an Office 365 Protection Source when the environment is set to ''kO365''.' allOf: - $ref: '#/components/schemas/Office365ProtectionSource' oracleProtectionSource: description: 'Specifies details about an Oracle Protection Source when the environment is set to ''kOracle''.' allOf: - $ref: '#/components/schemas/OracleProtectionSource' parentId: description: Specifies an id of the parent of the Protection Source. type: - integer - 'null' format: int64 x-go-name: ParentId physicalProtectionSource: description: 'Specifies details about a Physical Protection Source when the environment is set to ''kPhysical''.' allOf: - $ref: '#/components/schemas/PhysicalProtectionSource' pureProtectionSource: description: 'Specifies details about a Pure Protection Source when the environment is set to ''kPure''.' allOf: - $ref: '#/components/schemas/PureProtectionSource' sqlProtectionSource: description: 'Specifies details about a SQL Protection Source when the environment is set to ''kSQL''.' allOf: - $ref: '#/components/schemas/SqlProtectionSource' viewProtectionSource: description: 'Specifies details about a View Protection Source when the environment is set to ''kView''.' allOf: - $ref: '#/components/schemas/ViewProtectionSource' vmWareProtectionSource: description: 'Specifies details about a VMware Protection Source when the environment is set to ''kVMware''.' allOf: - $ref: '#/components/schemas/VMwareProtectionSource' x-go-package: cohesity/iris/server/data/public CifsShareInfo: description: Specifies information about a CIFS share of a NetApp volume. type: object title: CIFS Share Information. properties: acls: description: 'Array of Access Control Lists. Specifies the ACLs for this share.' type: - array - 'null' items: type: string x-go-name: Acls name: description: 'Specifies the name of the CIFS share. This can be different from the volume name that this share belongs to. A single volume can export multiple CIFS shares, each with unique settings such as permissions.' type: - string - 'null' x-go-name: Name path: description: Specifies the path of this share under the Vserver's root. type: - string - 'null' x-go-name: Path serverName: description: 'Specifies the CIFS server name (such as ''NETAPP-01'') specified by the system administrator. This name is searchable within the active directory domain.' type: - string - 'null' x-go-name: ServerName x-go-package: cohesity/iris/server/data/public MongoDBCluster: description: Specifies an Object containing information about a mongodb cluster. type: object title: MongoDB Cluster Info. properties: seeds: description: Seeds of this MongoDB Cluster. type: - array - 'null' items: type: string x-go-name: Seeds x-go-package: cohesity/iris/server/data/public CassandraPortsInfo: description: Specifies an Object containing information on various Cassandra ports. type: object title: Cassandra Ports Info. properties: jmxPort: description: Specifies the Cassandra JMX port. type: - integer - 'null' format: uint32 x-go-name: JmxPort nativeTransportPort: description: Specifies the port for the CQL native transport. type: - integer - 'null' format: uint32 x-go-name: NativeTransportPort rpcPort: description: 'Specifies the Remote Procedure Call (RPC) port for general mechanism for client-server applications.' type: - integer - 'null' format: uint32 x-go-name: RpcPort sslStoragePort: description: Specifies the SSL port for encrypted communication. type: - integer - 'null' format: uint32 x-go-name: SslStoragePort storagePort: description: Specifies the TCP port for data. Internally used by Cassandra bulk loader. type: - integer - 'null' format: uint32 x-go-name: StoragePort x-go-package: cohesity/iris/server/data/public MongoDBProtectionSource: description: Specifies an Object representing MongoDB. type: object title: MongoDB Protection Source. properties: clusterInfo: description: 'Information of a mongodb cluster, only valid for an entity of type kCluster.' $ref: '#/components/schemas/MongoDBCluster' collectionInfo: description: 'Information about a mongodb collection, only valid for an entity of type kCollection.' $ref: '#/components/schemas/MongoDBCollection' databaseInfo: description: 'Information of a mongodb database, only valid for an entity of type kDatabase.' $ref: '#/components/schemas/MongoDBDatabase' name: description: Specifies the instance name of the MongoDB entity. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of the managed Object in MongoDB Protection Source. Specifies the type of an MongoDB source entity. ''kCluster'' indicates a mongodb cluster distributed over several physical nodes. ''kDatabase'' indicates a Database within the MongoDB environment. ''kCollection'' indicates a Collection in the MongoDB enironment.' type: - string - 'null' enum: - kCluster - kDatabase - kCollection x-go-name: Type uuid: description: Specifies the UUID for the MongoDB entity. type: - string - 'null' x-go-name: Uuid x-go-package: cohesity/iris/server/data/public 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 SourcesForSid: description: 'Protection Sources and Views With Access Permissions. Specifies the Protection Sources objects and Views that the specified principal has permissions to access. The principal is specified using a security identifier (SID).' type: object title: Sources for Sid. properties: protectionSources: description: 'Array of Protection Sources. Specifies the Protection Source objects that the specified principal has permissions to access.' type: - array - 'null' items: $ref: '#/components/schemas/ProtectionSource' x-go-name: ProtectionSources sid: description: Specifies the security identifier (SID) of the principal. type: - string - 'null' x-go-name: Sid views: description: 'Array of View Names. Specifies the names of the Views that the specified principal has permissions to access.' type: - array - 'null' items: $ref: '#/components/schemas/View' x-go-name: Views x-go-package: cohesity/iris/server/data/public CreatedApiKey: description: Specifies a created API key. type: object title: Created API key. properties: createdTimeMsecs: description: Specifies the API key created time in milli seconds. type: - integer - 'null' format: int64 x-go-name: CreatedTimeMsecs createdUserSid: description: Specifies the user sid who created this API key. type: - string - 'null' x-go-name: CreatedUserSid createdUsername: description: Specifies the username who created this API key. type: - string - 'null' x-go-name: CreatedUsername expiringTimeMsecs: description: Specifies a time stamp when the API key will expire in milli seconds. type: - integer - 'null' format: int64 x-go-name: ExpiringTimeMsecs id: description: Specifies the API key id. type: - string - 'null' x-go-name: Id isActive: description: 'Specifies if the API key is active. Only an active and not expired API key can be used for authentication.' type: - boolean - 'null' x-go-name: IsActive isExpired: description: 'Specifies if the API key is expired. Expired API keys cannot be used for authentication.' type: - boolean - 'null' x-go-name: IsExpired key: description: Specifies the created key. type: - string - 'null' x-go-name: Key name: description: Specifies the API key name. type: - string - 'null' x-go-name: Name ownerUserSid: description: Specifies the user sid who owns this API key. type: - string - 'null' x-go-name: OwnerUserSid ownerUsername: description: Specifies the username who owns this API key. type: - string - 'null' x-go-name: OwnerUsername x-go-package: cohesity/iris/server/data/public SourceForPrincipalParam: description: 'Set Access Permissions for a Principal. For the specified principal, grant access permissions to the the specified Protection Sources and View names.' type: object title: Source for Principal Parameters. properties: protectionSourceIds: description: 'Array of Protection Source Ids. For the specified principal, grant access permissions to the Protection Sources listed in this array.' type: - array - 'null' items: type: integer format: int64 x-go-name: ProtectionSourceIds sid: description: Specifies the SID of the principal to grant access permissions to. type: - string - 'null' x-go-name: Sid viewNames: description: 'Array of View names. For the specified principal, grant access permissions to the Views names listed in this array.' type: - array - 'null' items: type: string x-go-name: ViewNames 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 PhysicalVolume: description: Specifies volume information about a Physical Protection Source. type: object title: Physical Volume. properties: devicePath: description: Specifies the path to the device that hosts the volume locally. type: - string - 'null' x-go-name: DevicePath guid: description: Specifies an id for the Physical Volume. type: - string - 'null' x-go-name: Guid isBootVolume: description: Specifies whether the volume is boot volume. type: - boolean - 'null' x-go-name: IsBootVolume isExtendedAttributesSupported: description: 'Specifies whether this volume supports extended attributes (like ACLs) when performing file backups.' type: - boolean - 'null' x-go-name: IsExtendedAttributesSupported isProtected: description: Specifies if a volume is protected by a Job. type: - boolean - 'null' x-go-name: IsProtected isSharedVolume: description: Specifies whether the volume is shared volume. type: - boolean - 'null' x-go-name: IsSharedVolume label: description: 'Specifies a volume label that can be used for displaying additional identifying information about a volume.' type: - string - 'null' x-go-name: Label logicalSizeBytes: description: 'Specifies the logical size of the volume in bytes that is not reduced by change-block tracking, compression and deduplication.' type: - integer - 'null' format: uint64 x-go-name: LogicalSizeBytes mountPoints: description: 'Array of Mount Points. Specifies the mount points where the volume is mounted, for example: ''C:\'', ''/mnt/foo'' etc.' type: - array - 'null' items: type: string x-go-name: MountPoints mountType: description: Specifies mount type of volume e.g. nfs, autofs, ext4 etc. type: - string - 'null' x-go-name: MountType networkPath: description: 'Specifies the full path to connect to the network attached volume. For example, (IP or hostname):/path/to/share for NFS volumes).' type: - string - 'null' x-go-name: NetworkPath usedSizeBytes: description: Specifies the size used by the volume in bytes. type: - integer - 'null' format: uint64 x-go-name: UsedSizeBytes x-go-package: cohesity/iris/server/data/public SmbPermission: description: Specifies information about a single SMB permission. type: object title: SMB Permission. properties: access: description: 'Specifies the read/write access to the SMB share. ''kReadyOnly'' indicates read only access to the SMB share. ''kReadWrite'' indicates read and write access to the SMB share. ''kFullControl'' indicates full administrative control of the SMB share. ''kSpecialAccess'' indicates custom permissions to the SMB share using access masks structures. ''kSuperUser'' indicates root permissions ignoring all SMB ACLs.' type: - string - 'null' enum: - kReadOnly - kReadWrite - kModify - kFullControl - kSpecialAccess - kSuperUser x-go-name: Access mode: description: 'Specifies how the permission should be applied to folders and/or files. ''kFolderSubFoldersAndFiles'' indicates that permissions are applied to a Folder and it''s sub folders and files. ''kFolderAndSubFolders'' indicates that permissions are applied to a Folder and it''s sub folders. ''kFolderAndSubFiles'' indicates that permissions are applied to a Folder and it''s sub files. ''kFolderOnly'' indicates that permsission are applied to folder only. ''kSubFoldersAndFilesOnly'' indicates that permissions are applied to sub folders and files only. ''kSubFoldersOnly'' indicates that permissiona are applied to sub folders only. ''kFilesOnly'' indicates that permissions are applied to files only.' type: - string - 'null' enum: - kFolderSubFoldersAndFiles - kFolderAndSubFolders - kFolderAndFiles - kFolderOnly - kSubFoldersAndFilesOnly - kSubFoldersOnly - kFilesOnly x-go-name: Mode sid: description: Specifies the security identifier (SID) of the principal. type: - string - 'null' x-go-name: Sid specialAccessMask: description: 'Specifies custom access permissions. When the access mask from the Access Control Entry (ACE) cannot be mapped to one of the enums in ''access'', this field is populated with the custom mask derived from the ACE and ''access'' is set to kSpecialAccess. This is a placeholder for storing an unmapped access permission and should not be set when creating and editing a View.' type: - integer - 'null' format: uint32 x-go-name: SpecialAccessMask specialType: description: 'Specifies a custom type. When the type from the Access Control Entry (ACE) cannot be mapped to one of the enums in ''type'', this field is populated with the custom type derived from the ACE and ''type'' is set to kSpecialType. This is a placeholder for storing an unmapped type and should not be set when creating and editing a View.' type: - integer - 'null' format: int32 x-go-name: SpecialType type: description: 'Specifies the type of permission. ''kAllow'' indicates access is allowed. ''kDeny'' indicates access is denied. ''kSpecialType'' indicates a type defined in the Access Control Entry (ACE) does not map to ''kAllow'' or ''kDeny''.' type: - string - 'null' enum: - kAllow - kDeny - kSpecialType x-go-name: Type x-go-package: cohesity/iris/server/data/public NetappProtectionSource: description: Specifies a Protection Source in a NetApp environment. type: object title: NetApp Protection Source. properties: clusterInfo: description: 'Specifies information about a NetApp cluster and is only valid for a NetApp Object of type kCluster.' $ref: '#/components/schemas/NetappClusterInfo' isTopLevel: description: 'Specifies if this Object is a top level Object. Because a top level Object can either be a NetApp cluster or a Vserver, this cannot be determined only by type.' type: - boolean - 'null' x-go-name: IsTopLevel licenseTypes: description: 'Specifies the type of license available on Netapp Cluster ''kSnapmirrorCloud'' indicates a SnapMirror license on Netapp.' type: - array - 'null' items: type: string enum: - kSnapmirrorCloud x-go-name: LicenseTypes name: description: Specifies the name of the NetApp Object. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of managed NetApp Object in a NetApp Protection Source such as ''kCluster'', ''kVserver'' or ''kVolume''. ''kCluster'' indicates a Netapp cluster as a protection source. ''kVserver'' indicates a Netapp vserver in a cluster as a protection source. ''kVolume'' indicates a volume in Netapp vserver as a protection source.' type: - string - 'null' enum: - kCluster - kVserver - kVolume x-go-name: Type uuid: description: 'Specifies the globally unique ID of this Object assigned by the NetApp server.' type: - string - 'null' x-go-name: Uuid version: description: Specifies the version of Netapp Cluster. type: - string - 'null' x-go-name: Version volumeInfo: description: 'Specifies information about a NetApp volume and is only valid for a NetApp Object of type kVolume.' $ref: '#/components/schemas/NetappVolumeInfo' vserverInfo: description: 'Specifies information about a NetApp Vserver and is only valid for a NetApp Object of type kVserver.' $ref: '#/components/schemas/NetappVserverInfo' x-go-package: cohesity/iris/server/data/public 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 Office365UserInfo: description: Specifies information about an Office365 user. type: object title: Office 365 User Info. properties: city: description: Specifies the city in which the Office365 user is located. type: - string - 'null' x-go-name: City country: description: Specifies the country/region in which the Office365 user is located. type: - string - 'null' x-go-name: Country department: description: Specifies the department within the enterprise of the Office365 user. type: - string - 'null' x-go-name: Department designation: description: Specifies the designation of the Office365 user. type: - string - 'null' x-go-name: Designation graphUuid: description: Specifies the MS Graph UUID for the given user entity. type: - string - 'null' x-go-name: GraphUuid mailboxSize: description: 'Specifies the size of the Outlook Mailbox associated with this Office365 entity.' type: - integer - 'null' format: int64 x-go-name: MailboxSize oneDriveId: description: 'Specifies the Id of the OneDrive associated with the this Office 365 entity.' type: - string - 'null' x-go-name: OneDriveId oneDriveSize: description: Specifies the size of the OneDrive associated with this Office365 entity. type: - integer - 'null' format: int64 x-go-name: OneDriveSize x-go-package: cohesity/iris/server/data/public VserverNetworkInterface: description: 'Specifies information about a logical network interface on a NetApp Vserver. The interface''s IP address is the mount point for a specific data protocol, such as NFS or CIFS.' type: object title: Vserver Network Interface. properties: dataProtocols: description: 'Array of Data Protocols. Specifies the set of data protocols supported by this interface. ''kNfs'' indicates NFS connections. ''kCifs'' indicates SMB (CIFS) connections. ''kIscsi'' indicates iSCSI connections. ''kFc'' indicates Fiber Channel connections. ''kFcache'' indicates Flex Cache connections. ''kHttp'' indicates HTTP connections. ''kNdmp'' indicates NDMP connections. ''kManagement'' indicates non-data connections used for management purposes. ''kNvme'' indicates NVMe connections.' type: - array - 'null' items: type: string enum: - kNfs - kCifs - kIscsi - kFc - kFcache - kHttp - kNdmp - kManagement - kNvme x-go-name: DataProtocols ipAddress: description: Specifies the IP address of this interface. type: - string - 'null' x-go-name: IpAddress name: description: Specifies the name of this interface. type: - string - 'null' x-go-name: Name x-go-package: cohesity/iris/server/data/public ViewAlias: description: Specifies the parameters of a view alias. type: object title: Alias. properties: aliasName: description: Alias name. type: - string - 'null' x-go-name: AliasName enableSmbEncryption: description: 'Specifies the SMB encryption for the View Alias. If set, it enables the SMB encryption for the View Alias. Encryption is supported only by SMB 3.x dialects. Dialects that do not support would still access data in unencrypted format.' type: - boolean - 'null' x-go-name: EnableSmbEncryption enableSmbViewDiscovery: description: If set, it enables discovery of view alias for SMB. type: - boolean - 'null' x-go-name: EnableSmbViewDiscovery enforceSmbEncryption: description: 'Specifies the SMB encryption for all the sessions for the View Alias. If set, encryption is enforced for all the sessions for the View Alias. When enabled all future and existing unencrypted sessions are disallowed.' type: - boolean - 'null' x-go-name: EnforceSmbEncryption sharePermissions: description: Specifies a list of share level permissions. type: - array - 'null' items: $ref: '#/components/schemas/SmbPermission' x-go-name: SharePermissions subnetWhitelist: description: 'Specifies a list of Subnets with IP addresses that have permissions to access the View Alias. (Overrides the Subnets specified at the global Cohesity Cluster level and View level.)' type: - array - 'null' items: $ref: '#/components/schemas/Subnet' x-go-name: SubnetWhitelist viewName: description: View name. type: - string - 'null' x-go-name: ViewName viewPath: description: View path for the alias. type: - string - 'null' x-go-name: ViewPath x-go-package: cohesity/iris/server/data/public ElastifileProtectionSource: description: Specifies a Protection Source in Elastifile environment. type: object title: Elastifile Protection Source. properties: cluster: description: 'Specifies information of Elastifile Cluster. This is set only when the entity type is ''kCluster''.' $ref: '#/components/schemas/ElastifileCluster' container: description: 'Specifies a container in an Elastifile Cluster. This is set only when the entity type is ''kContainer''.' $ref: '#/components/schemas/ElastifileContainer' name: description: Specifies a unique name of the Protection Source. type: - string - 'null' x-go-name: Name type: description: 'Specifies the type of the entity in an Elastifile file system like ''kCluster'', ''kContainer''. ''kCluster'' indicates an Elastifile Cluster. ''kContainer'' indicates a container on Elastifile cluster.' type: - string - 'null' enum: - kCluster - kContainer x-go-name: Type x-go-package: cohesity/iris/server/data/public OracleContainerDatabaseInfo: description: 'Specifies the Container Database information along with the Pluggable DBs within the container. The multitenant architecture enables an Oracle database to function as a multitenant container database (CDB). A CDB includes zero, one, or many customer-created pluggable databases (PDBs).' type: object properties: pluggableDatabaseInfoList: description: Specifies the list of Pluggable databases within this Container Database. type: - array - 'null' items: $ref: '#/components/schemas/OraclePluggableDatabaseInfo' x-go-name: PluggableDatabaseInfoList x-go-package: cohesity/iris/server/data/public ExchangeDAGProtectionPreference: description: 'Specifies the information about the preference order while choosing between which database copy of the database which is part of DAG should be protected.' type: object title: Exchange DAG Backup preference properties: passiveCopyPreferenceServerGuidList: description: 'Specifies the preference order of the exchange servers from which passive database copies should be protected. The preference order is descending which indicates that passive database copy in the first server in the list gets the highest preference.' type: - array - 'null' items: type: string x-go-name: PassiveCopyPreferenceServerGuidList passiveOnly: description: 'Specifies that only passive database copies should be protected if this is set to true. If this is set to false, both active and passive database copies can be protected.' type: - boolean - 'null' x-go-name: PassiveOnly useUserSpecifiedPassivePreferenceOrder: description: 'Specifies to use the user specified preference order of exchange servers from which the passive database copies should be protected if this is set to true. Every copy of an Exchange database in a DAG is assigned an activation preference number. This number is used by the system as part of the passive database activation process. If this bool flag is set to false, the reverse order of activation is used while choosing between passive copies.' type: - boolean - 'null' x-go-name: UseUserSpecifiedPassivePreferenceOrder x-go-package: cohesity/iris/server/data/public NetappVolumeInfo: description: Specifies information about a volume in a NetApp cluster. type: object title: NetApp Volume Information. properties: aggregateName: description: Specifies the containing aggregate name of this volume. type: - string - 'null' x-go-name: AggregateName capacityBytes: description: Specifies the total capacity in bytes of this volume. type: - integer - 'null' format: int64 x-go-name: CapacityBytes cifsShares: description: 'Array of CIFS Shares. Specifies the set of CIFS Shares exported for this volume.' type: - array - 'null' items: $ref: '#/components/schemas/CifsShareInfo' x-go-name: CifsShares creationTimeUsecs: description: 'Specifies the creation time of the volume specified in Unix epoch time (in microseconds).' type: - integer - 'null' format: int64 x-go-name: CreationTimeUsecs dataProtocols: description: 'Array of Data Protocols. Specifies the set of data protocols supported by this volume. ''kNfs'' indicates NFS connections. ''kCifs'' indicates SMB (CIFS) connections. ''kIscsi'' indicates iSCSI connections. ''kFc'' indicates Fiber Channel connections. ''kFcache'' indicates Flex Cache connections. ''kHttp'' indicates HTTP connections. ''kNdmp'' indicates NDMP connections. ''kManagement'' indicates non-data connections used for management purposes. ''kNvme'' indicates NVMe connections.' type: - array - 'null' items: type: string enum: - kNfs - kCifs - kIscsi - kFc - kFcache - kHttp - kNdmp - kManagement - kNvme x-go-name: DataProtocols exportPolicyName: description: 'Specifies the name of the export policy (which defines the access permissions for the mount client) that has been assigned to this volume.' type: - string - 'null' x-go-name: ExportPolicyName junctionPath: description: 'Specifies the junction path of this volume. This path can be used to mount this volume via protocols such as NFS.' type: - string - 'null' x-go-name: JunctionPath name: description: Specifies the name of the NetApp Vserver that this volume belongs to. type: - string - 'null' x-go-name: Name securityInfo: description: Specifies the security information of this volume. $ref: '#/components/schemas/VolumeSecurityInfo' state: description: 'Specifies the state of this volume. Specifies the state of a NetApp Volume. ''kOnline'' indicates the volume is online. Read and write access to this volume is allowed. ''kRestricted'' indicates the volume is restricted. Some operations, such as parity reconstruction, are allowed, but data access is not allowed. ''kOffline'' indicates the volume is offline. No access to the volume is allowed. ''kMixed'' indicates the volume is in mixed state, which means its aggregates are not all in the same state.' type: - string - 'null' enum: - kOnline - kRestricted - kOffline - kMixed x-go-name: State type: description: 'Specifies the NetApp type of this volume. Specifies the type of a NetApp Volume. ''kReadWrite'' indicates read-write volume. ''kLoadSharing'' indicates load-sharing volume. ''kDataProtection'' indicates data-protection volume. ''kDataCache'' indicates data-cache volume. ''kTmp'' indicates temporary purpose. ''kUnknownType'' indicates unknown type.' type: - string - 'null' enum: - kReadWrite - kLoadSharing - kDataProtection - kDataCache - kTmp - kUnknownType x-go-name: Type usedBytes: description: Specifies the total space (in bytes) used in this volume. type: - integer - 'null' format: int64 x-go-name: UsedBytes x-go-package: cohesity/iris/server/data/public responses: ResetS3SecretKeyResponse: description: New S3 Secret Access Key. content: application/json: schema: $ref: '#/components/schemas/NewS3SecretAccessKey' GetApiKeysResponse: description: Success content: application/json: schema: type: array title: Specifies a list of API keys for this user. items: $ref: '#/components/schemas/ApiKey' ListSourcesForPrincipalsResponse: description: Success content: application/json: schema: description: 'Specifies the Protection Source objects and Views that the specified list of principals have permissions to access.' type: array title: Array of Protection Source Objects and Views. items: $ref: '#/components/schemas/SourcesForSid' NoContentResponse: description: No Content CreateUserResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/User' GetApiKeyByIdResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/ApiKey' GetSessionUserResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/User' RotateUserApiKeyResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/CreatedApiKey' CreateApiKeyResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/CreatedApiKey' SearchPrincipalsResponse: description: Success content: application/json: schema: description: List of principals matching the specified filter criteria. type: array title: Array of Principals. items: $ref: '#/components/schemas/Principal' GetUsersResponse: description: Success content: application/json: schema: description: Specifies the users that match the specified search criteria. type: array title: Array of Users. items: $ref: '#/components/schemas/User' Error: description: Error content: application/json: schema: $ref: '#/components/schemas/RequestError' GetUserPrivilegesResponse: description: Success content: application/json: schema: description: List of privileges for the session user. type: array title: Array of Privileges. items: type: string UpdateUserResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/User'