openapi: 3.2.0 info: title: Cohesity Views API version: '1.0' description: 'Operations tagged Views across 2 of this provider''s published API definitions: cohesity-cluster-v1-openapi-original.yml, cohesity-cluster-v2-openapi-original.yml. Each path carries the servers of the definition it was published in.' servers: - url: https:///irisservices/api/v1 - url: /v2 tags: - name: Views paths: /public/nlmLocks: get: description: 'If no parameters are specified, all NLM locks currently on the Cohesity Cluster are returned. Specifying parameters filters the results that are returned.' tags: - Views summary: List the NLM locks that match the filter criteria specified using parameters operationId: ListNlmLocks parameters: - x-go-name: FilePath description: 'Specifies the filepath in the view relative to the root filesystem. If this field is specified, viewName field must also be specified.' name: filePath in: query schema: type: string - x-go-name: ViewName description: 'Specifies the name of the View in which to search. If a view name is not specified, all the views in the Cluster is searched. This field is mandatory if filePath field is specified.' name: viewName in: query schema: type: string - x-go-name: PageCount description: 'Specifies the maximum number of NLM locks to return in the response. This field cannot be set above 1000. If this is not set, maximum of 1000 entries are returned.' name: pageCount in: query schema: type: integer format: int32 - x-go-name: Cookie description: 'Specifies the opaque string returned in the previous response. If this is set, next set of active opens just after the previous response are returned. If this is not set, first set of NLM locks are returned.' name: cookie in: query schema: type: string responses: '200': $ref: '#/components/responses/GetListNlmLocksResponse' default: $ref: '#/components/responses/Error' delete: description: Returns nothing upon success. tags: - Views summary: Clear NLM locks that match the filter criteria specified using parameters operationId: ClearNlmLocks responses: '204': $ref: '#/components/responses/NoContentResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/ClearNlmLocksParameters' description: Request to clear NLM locks. required: true servers: - url: https:///irisservices/api/v1 /public/qosPolicies: get: description: Returns error if op fails. tags: - Views summary: Fetches QoS Policies of a view operationId: GetQoSPolicies parameters: - x-go-name: Ids description: Specifies the Ids of QoS Policies to filter by. name: ids in: query schema: type: array items: type: integer format: int64 - x-go-name: Names description: Specifies the names of QoS Policies to filter by. name: names in: query schema: type: array items: type: string responses: '200': $ref: '#/components/responses/GetQoSPoliciesResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/shares: get: description: 'If no parameters are specified, all shares on the Cohesity Cluster are returned. Specifying share name/prefix filters the results that are returned. NOTE: If maxCount is set and the number of Views returned exceeds the maxCount, there are more Views to return. To get the next set of Views, send another request and specify the pagination cookie from the previous response.' tags: - Views summary: List shares filtered by name operationId: GetViewsByShareName 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: ShareName description: 'The share name(substring) that needs to be searched against existing views and aliases.' name: shareName in: query schema: type: string - x-go-name: MaxCount description: Specifies a limit on the number of Views returned. name: maxCount in: query schema: type: integer format: int32 - x-go-name: PaginationCookie description: 'Expected to be empty in the first call to GetViewsByShareName. To get the next set of results, set this value to the pagination cookie value returned in the response of the previous call.' name: paginationCookie in: query schema: type: string - x-go-name: MatchPartialNames description: 'If true, the names in viewNames are matched by prefix rather than exactly matched.' name: matchPartialNames in: query schema: type: boolean responses: '200': $ref: '#/components/responses/GetViewsByShareNameResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/smbConnections: get: description: Returns error if op fails. tags: - Views summary: Fetches Smb Connection Status of a view operationId: GetSmbConnections parameters: - x-go-name: ViewNames description: 'Parameters to get Smb Connections. List of names of views whose connections are to be fetched.' name: viewNames in: query schema: type: array items: type: string - x-go-name: ViewIds description: List of ids of views whose connections are to be fetched. name: viewIds in: query schema: type: array items: type: integer format: int64 - x-go-name: MaxCount description: Maximum number of results to return. name: maxCount in: query schema: type: integer format: int32 - x-go-name: IncludeSid description: Specifies whether to include list of sids in the result. name: includeSid in: query schema: type: boolean responses: '200': $ref: '#/components/responses/GetSmbConnectionsResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/viewAliases: put: description: Returns the updated View Alias. tags: - Views summary: Update a View Alias. operationId: UpdateViewAlias responses: '201': $ref: '#/components/responses/UpdateViewAliasResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateViewAliasParam' description: Request to update a View. required: true post: description: Returns the created View Alias. tags: - Views summary: Create a View Alias. operationId: CreateViewAlias responses: '201': $ref: '#/components/responses/CreateViewAliasResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/ViewAlias' description: Request to create a View Alias. required: true servers: - url: https:///irisservices/api/v1 /public/viewAliases/{name}: delete: description: Returns delete status upon completion. tags: - Views summary: Delete a View Alias operationId: DeleteViewAlias parameters: - x-go-name: Name description: Specifies the View Alias name. name: name in: path required: true schema: type: string responses: '204': $ref: '#/components/responses/NoContentResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/viewAliases/{name}/activate: post: description: Returns error if op fails. tags: - Views summary: Activates the view aliases of a view from it's source view operationId: ActivateViewAliases parameters: - x-go-name: Name description: Specifies the View name. name: name in: path required: true schema: type: string responses: '200': $ref: '#/components/responses/ActivateViewAliasesResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/viewDirectoryQuotas: get: tags: - Views summary: Gets directory quota info for a view. Returns error if op fails operationId: GetViewDirQuotaInfo parameters: - x-go-name: ViewName description: The name of the view. name: viewName in: query required: true schema: type: string responses: '200': $ref: '#/components/responses/GetDirQuotaInfoResponse' default: $ref: '#/components/responses/Error' put: tags: - Views summary: Updates a directory quota policy for a view. Returns error if op fails operationId: UpdateViewDirQuota responses: '200': $ref: '#/components/responses/UpdateViewDirQuotaResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDirQuotaArgs' description: Request to update view directory quota policy. required: true servers: - url: https:///irisservices/api/v1 /public/viewUserQuotas: get: description: Returns error if op fails. tags: - Views summary: Get the quota policies, usage and summary for a view for all its users. operationId: GetViewUserQuotas parameters: - x-go-name: ViewName description: 'Specifies the name of the input view. If given, there could be three scenarios with the viewName input parameter: It gives the user quota overrides for this view, and the user quota settings. Returns ''usersQuotaAndUsage''. If given along with the user id, it returns the quota policy for this user on this view. Returns ''usersQuotaAndUsage''. If given along with SummaryOnly as true, a user quota summary for this view would be returned. Returns ''summaryForView''. If not given, then the user id is checked.' name: viewName in: query schema: type: string - x-go-name: IncludeUsage description: 'If set to true, the logical usage info is included only for users with quota overrides. By default, it is set to false.' name: includeUsage in: query schema: type: boolean - x-go-name: IncludeUserWithQuotaOnly description: 'If set to true, the result will only contain user with user quota enabled. By default, this field is set to false, and it''s only in effect when ''SummaryOnly'' is set to false and ''ViewName'' is specified.' name: includeUserWithQuotaOnly in: query schema: type: boolean - x-go-name: ExcludeUsersWithinAlertThreshold description: 'This field can be set only when includeUsage is set to true. By default, all the users with logical usage > 0 will be returned in the result. If this field is set to true, only the list of users who has exceeded the alert threshold will be returned.' name: excludeUsersWithinAlertThreshold in: query schema: type: boolean - x-go-name: UnixUid description: 'If interested in a user via unix-identifier, include UnixUid. Otherwise, If a valid unix-id to SID mappings are available (i.e., when mixed mode is enabled) the server will perform the necessary id mapping and return the correct usage irrespective of whether the unix id / SID is provided.' name: unixUid in: query schema: type: integer format: uint32 - x-go-name: Sid description: 'If interested in a user via smb_client, include SID. Otherwise, If a valid unix-id to SID mappings are available (i.e., when mixed mode is enabled) the server will perform the necessary id mapping and return the correct usage irrespective of whether the unix id / SID is provided. The string is of following format - S-1-IdentifierAuthority-SubAuthority1-SubAuthority2-...-SubAuthorityn.' name: sid in: query schema: type: string - x-go-name: UserUnixIdsForView description: 'While making a query for a view, this specifies a list of specific users with their unix uid for the result.' name: userUnixIdsForView in: query schema: type: array items: type: integer format: uint32 - x-go-name: UserSidsForView description: 'While making a query for a view, this specifies a list of specific users with their Sid for the result.' name: userSidsForView in: query schema: type: array items: type: string - x-go-name: ViewNamesForUser description: 'While making a query for a user, this specifies a list of specific views for the result.' name: viewNamesForUser in: query schema: type: array items: type: string - x-go-name: SummaryOnly description: 'Specifies a flag to just return a summary. If set to true, and if ViewName is not nil, it returns the summary of users for a view. Otherwise if UserId not nil, and ViewName is nil then it fetches the summary for a user in his views. By default, it is set to false.' name: summaryOnly in: query schema: type: boolean - x-go-name: PageCount description: Specifies the max entries that should be returned in the result. name: pageCount in: query schema: type: integer format: int64 - x-go-name: MaxViewId description: 'Related to fetching a particular user''s quota and usage in all his views. It only pertains to the scenario where either UnixUid or Sid is specified, and ViewName is nil. Specify the maxViewId for All the views returned would have view_id''s less than or equal to the given MaxViewId if it is >= 0.' name: maxViewId in: query schema: type: integer format: int64 - x-go-name: Cookie description: 'Cookie should be used from previous call to list user quota overrides. It resumes (or gives the next set of values) from the result of the previous call.' name: cookie in: query schema: type: string - x-go-name: OutputFormat description: 'OutputFormat is the Output format for the output. If it is not specified, default is json.' name: outputFormat in: query schema: type: string responses: '200': $ref: '#/components/responses/GetViewUserQuotasResponse' default: $ref: '#/components/responses/Error' put: description: Returns error if op fails. tags: - Views summary: Update a new quota policy for a user in a view operationId: UpdateViewUserQuota responses: '201': $ref: '#/components/responses/UpdateViewUserQuotaResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/ViewUserQuotaParameters' description: update user quota params. post: description: Returns error if op fails. tags: - Views summary: Create a new quota policy for a user in a view operationId: CreateViewUserQuota responses: '200': $ref: '#/components/responses/CreateViewUserQuotaResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/ViewUserQuotaParameters' description: update user quota params. delete: description: Returns error if op fails. tags: - Views summary: Delete the quota policy overrides for users in a view operationId: DeleteViewUsersQuota responses: '204': $ref: '#/components/responses/NoContentResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteViewUsersQuotaParameters' description: update user quota params. servers: - url: https:///irisservices/api/v1 /public/viewUserQuotasSettings: put: description: Returns error if op fails. tags: - Views summary: Update the user quota settings in a view operationId: UpdateUserQuotaSettings responses: '200': $ref: '#/components/responses/UserQuotaSettingsResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserQuotaSettingsForView' description: update user quota metadata params. servers: - url: https:///irisservices/api/v1 /public/views: get: description: 'If no parameters are specified, all Views on the Cohesity Cluster are returned. Specifying parameters filters the results that are returned. NOTE: If maxCount is set and the number of Views returned exceeds the maxCount, there are more Views to return. To get the next set of Views, send another request and specify the id of the last View returned in viewList from the previous response.' tags: - Views summary: List Views filtered by some parameters operationId: GetViews 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: ViewNameList description: Filter by a list of View names. name: viewNames in: query schema: type: array items: type: string - x-go-name: ViewIdList description: Filter by a list of View ids. name: viewIds in: query schema: type: array items: type: integer format: int64 - x-go-name: ViewBoxIdList description: Filter by a list of Storage Domains (View Boxes) specified by id. name: viewBoxIds in: query schema: type: array items: type: integer format: int64 - x-go-name: ViewBoxNameList description: Filter by a list of View Box names. name: viewBoxNames in: query schema: type: array items: type: string - x-go-name: MatchPartialNames description: 'If true, the names in viewNames are matched by prefix rather than exactly matched.' name: matchPartialNames in: query schema: type: boolean - x-go-name: MaxCount description: Specifies a limit on the number of Views returned. name: maxCount in: query schema: type: integer format: int32 - x-go-name: IncludeProtectionJobs description: 'Specifies if Protection Jobs information needs to be returned along with view metadata. By default, if not set or set to true, Job information is returned.' name: includeProtectionJobs in: query schema: type: boolean - x-go-name: MaxViewId description: 'If the number of Views to return exceeds the maxCount specified in the original request, specify the id of the last View from the viewList in the previous response to get the next set of Views.' name: maxViewId in: query schema: type: integer format: int64 - x-go-name: IncludeInactive description: 'Specifies if inactive Views on this Remote Cluster (which have Snapshots copied by replication) should also be returned. Inactive Views are not counted towards the maxCount. By default, this field is set to false.' name: includeInactive in: query schema: type: boolean - x-go-name: JobIds description: 'Filter by Protection Job ids. Return Views that are being protected by listed Jobs, which are specified by ids.' name: jobIds in: query schema: type: array items: type: integer format: int64 - description: If set to true, the list is sorted descending by logical usage. name: SortByLogicalUsage in: query schema: type: boolean - x-go-name: MatchAliasNames description: If true, view aliases are also matched with the names in viewNames. name: matchAliasNames in: query schema: type: boolean - x-go-name: IncludeViewsWithAntivirusEnabledOnly description: 'If set to true, the list will contain only the views for which antivirus scan is enabled.' name: includeViewsWithAntivirusEnabledOnly in: query schema: type: boolean - x-go-name: IncludeStats description: 'If set to true, stats of views will be returned. By default this parameter is set to false.' name: includeStats in: query schema: type: boolean - x-go-name: IncludeViewsWithDataLockEnabledOnly description: 'If set to true, the list will contain only the views for which either file level data lock is enabled or view level data lock is enabled.' name: includeViewsWithDataLockEnabledOnly in: query schema: type: boolean responses: '200': $ref: '#/components/responses/GetViewsResponse' default: $ref: '#/components/responses/Error' put: description: Returns the updated View. tags: - Views summary: Update a View operationId: UpdateView responses: '200': $ref: '#/components/responses/UpdateViewResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateViewParam' description: Request to update a view. required: true post: description: Returns the created View. tags: - Views summary: Create a View operationId: CreateView responses: '201': $ref: '#/components/responses/CreateViewResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateViewRequest' description: Request to create a View. required: true servers: - url: https:///irisservices/api/v1 /public/views/clone: post: description: Returns the cloned View. tags: - Views summary: Clone a View operationId: CloneView responses: '201': $ref: '#/components/responses/CloneViewResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/CloneViewRequest' description: Request to clone a View. required: true servers: - url: https:///irisservices/api/v1 /public/views/cloneDirectory: post: description: Returns error if op fails. tags: - Views summary: Clone a directory of a view operationId: CloneDirectory responses: '201': $ref: '#/components/responses/CloneDirectoryResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/CloneDirectoryParams' description: Request to clone a directory. required: true servers: - url: https:///irisservices/api/v1 /public/views/id/{id}: get: description: Returns the View corresponding to the specified View id. tags: - Views summary: List details about a single View operationId: GetViewById parameters: - x-go-name: Id description: Specifies the View id. name: id in: path required: true schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/GetViewByIdResponse' default: $ref: '#/components/responses/Error' delete: description: Returns delete status upon completion. tags: - Views summary: Delete a View operationId: DeleteViewById parameters: - x-go-name: Id description: Specifies the View id. name: id in: path required: true schema: type: integer format: int64 responses: '204': $ref: '#/components/responses/NoContentResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/views/id/{id}/fileLocks: get: description: Returns error if op fails. tags: - Views summary: Fetches the lock status of a file in a view operationId: GetFileLockStatusById parameters: - x-go-name: Path description: Specifies the file path that needs to be locked. name: path in: query schema: type: string - x-go-name: Id description: Specifies the View id. name: id in: path required: true schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/GetFileLockStatusResponse' default: $ref: '#/components/responses/Error' post: description: Returns error if op fails. tags: - Views summary: Lock a file in a view and optionally update its expiry timestamp operationId: LockFileById parameters: - x-go-name: Id description: Specifies the View id. name: id in: path required: true schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/GetFileLockStatusResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/LockFileParams' description: Request to lock a file. servers: - url: https:///irisservices/api/v1 /public/views/overwrite: post: description: 'Specifies source and target view names as params. Returns the modified Target View.' tags: - Views summary: Overwrites a Target view with contents of a Source view operationId: OverwriteView responses: '200': $ref: '#/components/responses/OverwriteViewResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/OverwriteViewParam' description: Request to overwrite a Target view with contents of a Source view. required: true servers: - url: https:///irisservices/api/v1 /public/views/rename/id/{id}: post: description: 'Specify unique id of the View in the ''id'' parameter. Returns the renamed View.' tags: - Views summary: Rename a View operationId: RenameViewById parameters: - x-go-name: Id description: Specifies the View id. name: id in: path required: true schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/RenameViewResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/RenameViewParam' description: Request to rename a View. required: true servers: - url: https:///irisservices/api/v1 /public/views/rename/{name}: post: description: 'Specify original name of the View in the ''name'' parameter. Returns the renamed View.' tags: - Views summary: Rename a View operationId: RenameView parameters: - x-go-name: Name description: Specifies the View name. name: name in: path required: true schema: type: string responses: '200': $ref: '#/components/responses/RenameViewResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/RenameViewParam' description: Request to rename a View. required: true servers: - url: https:///irisservices/api/v1 /public/views/{name}: get: description: Returns the View corresponding to the specified View name. tags: - Views summary: List details about a single View operationId: GetViewByName parameters: - x-go-name: Name description: Specifies the View name. name: name in: path required: true schema: type: string responses: '200': $ref: '#/components/responses/GetViewByNameResponse' default: $ref: '#/components/responses/Error' put: description: Returns the updated View. tags: - Views summary: Update a View operationId: UpdateViewByName parameters: - x-go-name: Name description: Specifies the View name. name: name in: path required: true schema: type: string responses: '200': $ref: '#/components/responses/UpdateViewResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateViewParam' description: Request to update a view. required: true delete: description: Returns delete status upon completion. tags: - Views summary: Delete a View operationId: DeleteView parameters: - x-go-name: Name description: Specifies the View name. name: name in: path required: true schema: type: string responses: '204': $ref: '#/components/responses/NoContentResponse' default: $ref: '#/components/responses/Error' servers: - url: https:///irisservices/api/v1 /public/views/{name}/fileLocks: get: description: Returns error if op fails. tags: - Views summary: Fetches the lock status of a file in a view operationId: GetFileLockStatus parameters: - x-go-name: Path description: Specifies the file path that needs to be locked. name: path in: query schema: type: string - x-go-name: Name description: Specifies the View name. name: name in: path required: true schema: type: string responses: '200': $ref: '#/components/responses/GetFileLockStatusResponse' default: $ref: '#/components/responses/Error' post: description: Returns error if op fails. tags: - Views summary: Lock a file in a view and optionally update its expiry timestamp operationId: LockFile parameters: - x-go-name: Name description: Specifies the View name. name: name in: path required: true schema: type: string responses: '200': $ref: '#/components/responses/GetFileLockStatusResponse' default: $ref: '#/components/responses/Error' requestBody: content: application/json: schema: $ref: '#/components/schemas/LockFileParams' description: Request to lock a file. servers: - url: https:///irisservices/api/v1 /file-services/view-template: get: description: 'All view templates on the Cohesity Cluster are returned. Specifying parameters filters the results that are returned.' tags: - Views summary: List View Templates operationId: ReadViewTemplates responses: '200': $ref: '#/components/responses/ReadViewTemplatesResponse' default: $ref: '#/components/responses/ErrorResponse' security: - APIKeyHeader: [] post: description: Creates a View Template. tags: - Views summary: Create a View Template operationId: CreateViewTemplate responses: '201': $ref: '#/components/responses/CreateViewTemplateResponse' default: $ref: '#/components/responses/ErrorResponse' security: - APIKeyHeader: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/Template' description: Request to create a view template. required: true servers: - url: /v2 /file-services/view-template/{id}: get: description: Reads a view template based on given template id. tags: - Views summary: Read a View Template by Id operationId: ReadViewTemplateById parameters: - description: Specifies a unique id of the view template. name: id in: path required: true schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/ReadViewTemplateByIdResponse' default: $ref: '#/components/responses/ErrorResponse' security: - APIKeyHeader: [] put: description: Updates a View Template. tags: - Views summary: Update a View Template operationId: UpdateViewTemplate parameters: - description: Specifies a unique id of the view template. name: id in: path required: true schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/UpdateViewTemplateResponse' default: $ref: '#/components/responses/ErrorResponse' security: - APIKeyHeader: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/Template' description: Request to update a view template. required: true delete: description: Deletes a view template based on given template id. tags: - Views summary: Delete a View Template operationId: DeleteViewTemplate parameters: - description: Specifies a unique id of the view template to delete. name: id in: path required: true schema: type: integer format: int64 responses: '204': $ref: '#/components/responses/NoContentResponse' default: $ref: '#/components/responses/ErrorResponse' security: - APIKeyHeader: [] servers: - url: /v2 /file-services/views: get: description: 'If no parameters are specified, all Views on the Cohesity Cluster are returned. Specifying parameters filters the results that are returned. NOTE: If maxCount is set and the number of Views returned exceeds the maxCount, there are more Views to return. To get the next set of Views, send another request and specify the id of the last View returned in viewList from the previous response.' tags: - Views summary: List Views operationId: getFileServicesViews parameters: - description: Filter by a list of View names. name: viewNames in: query schema: type: array items: type: string - description: Filter by a list of View ids. name: viewIds in: query schema: type: array items: type: integer format: int64 - description: Filter by a list of Storage Domains (View Boxes) specified by id. name: storageDomainIds in: query schema: type: array items: type: integer format: int64 - description: Filter by a list of View Box names. name: storageDomainNames in: query schema: type: array items: type: string - description: 'Filter by a list of protocol accesses. Only views with protocol accesses in these specified accesses list will be returned.' name: protocolAccesses in: query schema: type: array items: enum: - NFS - NFS4 - SMB - S3 - Swift type: string - description: 'If true, the names in viewNames are matched by any partial rather than exactly matched.' name: matchPartialNames in: query schema: type: boolean - description: Specifies a limit on the number of Views returned. name: maxCount in: query schema: type: integer format: int32 - description: 'Specifies if internal Views created by the Cohesity Cluster are also returned. In addition, regular Views are returned.' name: includeInternalViews in: query schema: type: boolean - description: 'Specifies if Protection Groups information needs to be returned along with view metadata. By default, if not set or set to true, Group information is returned.' name: includeProtectionGroups in: query schema: type: boolean - description: 'If the number of Views to return exceeds the maxCount specified in the original request, specify the id of the last View from the viewList in the previous response to get the next set of Views.' name: maxViewId in: query schema: type: integer format: int64 - description: 'Specifies if inactive Views on this Remote Cluster (which have Snapshots copied by replication) should also be returned. Inactive Views are not counted towards the maxCount. By default, this field is set to false.' name: includeInactive in: query schema: type: boolean - description: 'Filter by Protection Group ids. Return Views that are being protected by listed Groups, which are specified by ids.' name: protectionGroupIds in: query schema: type: array items: type: integer format: int64 - description: 'Whether to get just the total number of views with the given input filters. If the flag is true, we ignore the parameter ''maxViews'' for the count. Also, if flag is true, list of views will not be returned.' name: viewCountOnly in: query schema: type: boolean - description: If set to true, the list is sorted descending by logical usage. name: sortByLogicalUsage in: query schema: type: boolean - description: 'Sids of restricted principals who can access the view. This is an internal field and therefore does not have json tag.' name: internalAccessSids in: query schema: type: array items: type: string - description: If true, view aliases are also matched with the names in viewNames. name: matchAliasNames in: query schema: type: boolean - description: 'TenantIds contains ids of the tenants for which objects are to be returned.' name: tenantIds in: query schema: type: array items: type: string - description: 'IncludeTenants specifies if objects of all the tenants under the hierarchy of the logged in user''s organization should be returned.' name: includeTenants in: query schema: type: boolean - description: 'If set to true, stats of views will be returned. By default this parameter is set to false.' name: includeStats in: query schema: type: boolean - description: 'If set to true, the list will contain only the views for which antivirus scan is enabled.' name: includeViewsWithAntivirusEnabledOnly in: query schema: type: boolean - description: 'If set to true, the list will contain only the views for which either file level data lock is enabled or view level data lock is enabled.' name: includeViewsWithDataLockEnabledOnly in: query schema: type: boolean - description: 'If set to true, only views with filer audit log enabled will be returned. If set to false, only views with filer audit log disabled will be returned.' name: filerAuditLogEnabled in: query schema: type: boolean responses: '200': $ref: '#/components/responses/GetViewsResponse' default: $ref: '#/components/responses/ErrorResponse' security: - APIKeyHeader: [] x-operation-id-source: normalized x-operation-id-original: GetViews post: description: Creates a View. tags: - Views summary: Create a View operationId: postFileServicesViews responses: '201': $ref: '#/components/responses/CreateViewResponse' default: $ref: '#/components/responses/ErrorResponse' security: - APIKeyHeader: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateViewRequest_2' description: Request to create a View. required: true x-operation-id-source: normalized x-operation-id-original: CreateView servers: - url: /v2 /file-services/views/{id}: get: description: Get a View based on given Id. tags: - Views summary: Get a View by Id operationId: getFileServicesViewsById parameters: - description: Specifies a unique id of the View to delete. name: id in: path required: true schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/GetViewByIdResponse' default: $ref: '#/components/responses/ErrorResponse' security: - APIKeyHeader: [] x-operation-id-source: normalized x-operation-id-original: GetViewById put: description: Updates a View based on given id. tags: - Views summary: Update a View operationId: putFileServicesViewsById parameters: - description: Specifies a unique id of the View to update. name: id in: path required: true schema: type: integer format: int64 responses: '200': $ref: '#/components/responses/UpdateViewResponse' default: $ref: '#/components/responses/ErrorResponse' security: - APIKeyHeader: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/View_2' description: Request to update a view. required: true x-operation-id-source: normalized x-operation-id-original: UpdateView delete: description: Deletes a View based on given id. tags: - Views summary: Delete a View operationId: deleteFileServicesViewsById parameters: - description: Specifies a unique id of the View to delete. name: id in: path required: true schema: type: integer format: int64 responses: '204': $ref: '#/components/responses/NoContentResponse' default: $ref: '#/components/responses/ErrorResponse' security: - APIKeyHeader: [] x-operation-id-source: normalized x-operation-id-original: DeleteView servers: - url: /v2 components: responses: UpdateViewResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/View' CloneViewResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/View' UpdateViewUserQuotaResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/UserQuotaAndUsage' GetSmbConnectionsResponse: description: Success content: application/json: schema: type: array title: Get Smb connection status. items: $ref: '#/components/schemas/SmbConnection' CreateViewAliasResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/ViewAlias' RenameViewResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/View' UpdateViewAliasResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/ViewAlias' ActivateViewAliasesResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/ActivateViewAliasesResult' GetQoSPoliciesResponse: description: Success content: application/json: schema: type: array title: List of QoS Policies. items: $ref: '#/components/schemas/QoSPolicy' GetDirQuotaInfoResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/DirQuotaInfo' NoContentResponse: description: No Content GetViewsResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/GetViewsResult' CreateViewResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/View' GetViewUserQuotasResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/ViewUserQuotas' GetViewByNameResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/View' GetFileLockStatusResponse: description: Get lock file status response content: application/json: schema: $ref: '#/components/schemas/FileLockStatus' CloneDirectoryResponse: description: Success GetListNlmLocksResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/ListNlmLocksResponse' UpdateViewDirQuotaResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/DirQuotaInfo' CreateViewUserQuotaResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/UserQuotaAndUsage' GetViewByIdResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/View' Error: description: Error content: application/json: schema: $ref: '#/components/schemas/RequestError' GetViewsByShareNameResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/GetViewsByShareNameResult' OverwriteViewResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/View' UserQuotaSettingsResponse: description: The User Quota settings applied to a view. content: application/json: schema: $ref: '#/components/schemas/UserQuotaSettings' ErrorResponse: description: Error content: application/json: schema: $ref: '#/components/schemas/Error' CreateViewTemplateResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/Template' UpdateViewTemplateResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/Template' ReadViewTemplatesResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/GetViewTemplatesResult' ReadViewTemplateByIdResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/Template' schemas: UpdateUserQuotaSettingsForView: description: Specifies the parameters to update user quota metadata in a view. type: object title: Update User Quota Settings For View. properties: defaultUserQuotaPolicy: description: The default user quota policy for this view. $ref: '#/components/schemas/QuotaPolicy' enableUserQuota: description: 'If set, it enables/disables the user quota overrides for a view. Otherwise, it leaves it at it''s previous state.' type: - boolean - 'null' x-go-name: EnableUserQuota inheritDefaultPolicyFromViewbox: description: 'If set to true, the default_policy in view metadata will be cleared and the default policy from viewbox will take effect for all users in the view.' type: - boolean - 'null' x-go-name: InheritDefaultPolicyFromViewbox viewName: description: View name of input view. type: - string - 'null' x-go-name: ViewName 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 FileNlmLocks: description: Specifies per-file NLM locks type: object properties: fileId: description: File identitfiers $ref: '#/components/schemas/FileId' nlmLocks: description: Specifies the list of NLM locks in a view. type: - array - 'null' items: $ref: '#/components/schemas/NlmLock' x-go-name: NlmLocks x-go-package: cohesity/iris/server/data/public RenameViewParam: description: Specifies the rename parameters for the view. type: object title: Rename View Parameters. required: - newViewName properties: newViewName: description: Specifies the new name of the View. type: - string - 'null' x-go-name: NewViewName x-go-package: cohesity/iris/server/data/public UserQuotaSettings: description: Specifies the quota settings parameters for a particular user. type: object title: User Quota Settings. properties: defaultUserQuotaPolicy: description: The default user quota policy for this view. $ref: '#/components/schemas/QuotaPolicy' enableUserQuota: description: 'If set, it enables/disables the user quota overrides for a view. Otherwise, it leaves it at it''s previous state.' type: - boolean - 'null' x-go-name: EnableUserQuota 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 OverwriteViewParam: description: Specifies the overwrite parameters for the view. type: object title: Overwrite View Parameters. required: - sourceViewName - targetViewName properties: sourceViewName: description: Specifies the source view name. type: - string - 'null' x-go-name: SourceViewName targetViewName: description: Specifies the target view name. type: - string - 'null' x-go-name: TargetViewName x-go-package: cohesity/iris/server/data/public ActivateViewAliasesResult: description: 'Specifies the information of activated alias views created for a view.' type: object title: Activate View Aliases Result. properties: 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 x-go-package: cohesity/iris/server/data/public UpdateViewParam: description: Specifies the settings that define a View. type: object title: View. properties: accessSids: description: 'Array of Security Identifiers (SIDs) Specifies the list of security identifiers (SIDs) for the restricted Principals who have access to this View.' type: - array - 'null' items: type: string x-go-name: AccessSids antivirusScanConfig: description: Specifies the antivirus scan config settings for this View. $ref: '#/components/schemas/AntivirusScanConfig' description: description: Specifies an optional text description about the View. type: - string - 'null' x-go-name: Description enableFastDurableHandle: description: 'Specifies whether fast durable handle is enabled. If enabled, view open handle will be kept in memory, which results in a higher performance. But the handles cannot be recovered if node or service crashes.' type: - boolean - 'null' x-go-name: EnableFastDurableHandle enableFilerAuditLogging: description: Specifies if Filer Audit Logging is enabled for this view. type: - boolean - 'null' x-go-name: EnableFilerAuditLogging enableLiveIndexing: description: Specifies whether to enable live indexing for the view. type: - boolean - 'null' x-go-name: EnableLiveIndexing enableMixedModePermissions: description: 'If set, mixed mode (NFS and SMB) access is enabled for this view. This field is deprecated. Use the field SecurityMode. deprecated: true' type: - boolean - 'null' x-go-name: EnableMixedModePermissions enableNfsViewDiscovery: description: If set, it enables discovery of view for NFS. type: - boolean - 'null' x-go-name: EnableNfsViewDiscovery enableOfflineCaching: description: Specifies whether to enable offline file caching of the view. type: - boolean - 'null' x-go-name: EnableOfflineCaching enableSmbAccessBasedEnumeration: description: 'Specifies if access-based enumeration should be enabled. If ''true'', only files and folders that the user has permissions to access are visible on the SMB share for that user.' type: - boolean - 'null' x-go-name: EnableSmbAccessBasedEnumeration enableSmbEncryption: description: 'Specifies the SMB encryption for the View. If set, it enables the SMB encryption for the View. Encryption is supported only by SMB 3.x dialects. Dialects that do not support would still access data in unencrypted format.' type: - boolean - 'null' x-go-name: EnableSmbEncryption enableSmbOplock: description: Specifies whether SMB opportunistic lock is enabled. type: - boolean - 'null' x-go-name: EnableSmbOplock enableSmbViewDiscovery: description: If set, it enables discovery of view for SMB. type: - boolean - 'null' x-go-name: EnableSmbViewDiscovery enforceSmbEncryption: description: 'Specifies the SMB encryption for all the sessions for the View. If set, encryption is enforced for all the sessions for the View. When enabled all future and existing unencrypted sessions are disallowed.' type: - boolean - 'null' x-go-name: EnforceSmbEncryption fileExtensionFilter: description: 'Optional filtering criteria that should be satisfied by all the files created in this view. It does not affect existing files.' $ref: '#/components/schemas/FileExtensionFilter' fileLockConfig: description: 'Optional config that enables file locking for this view. It cannot be disabled during the edit of a view, if it has been enabled during the creation of the view. Also, it cannot be enabled if it was disabled during the creation of the view.' $ref: '#/components/schemas/FileLevelDataLockConfig' logicalQuota: description: 'Specifies an optional logical quota limit (in bytes) for the usage allowed on this View. (Logical data is when the data is fully hydrated and expanded.) This limit overrides the limit inherited from the Storage Domain (View Box) (if set). If logicalQuota is nil, the limit is inherited from the Storage Domain (View Box) (if set). A new write is not allowed if the Storage Domain (View Box) will exceed the specified quota. However, it takes time for the Cohesity Cluster to calculate the usage across Nodes, so the limit may be exceeded by a small amount. In addition, if the limit is increased or data is removed, there may be a delay before the Cohesity Cluster allows more data to be written to the View, as the Cluster is calculating the usage across Nodes.' allOf: - $ref: '#/components/schemas/QuotaPolicy' netgroupWhitelist: description: 'Array of Netgroups. Specifies a list of Netgroups that have permissions to access the View. (Overrides the Netgroups specified at the global Cohesity Cluster level.)' type: - array - 'null' items: $ref: '#/components/schemas/NisNetgroup' x-go-name: NetgroupWhitelist nfsAllSquash: description: Specifies the NFS all squash config. $ref: '#/components/schemas/NfsSquash' nfsRootPermissions: description: Specifies the NFS root permission config of the view file system. $ref: '#/components/schemas/NfsRootPermissions' nfsRootSquash: description: Specifies the NFS root squash config. $ref: '#/components/schemas/NfsSquash' overrideGlobalNetgroupWhitelist: description: 'Specifies whether view level client netgroup whitelist overrides cluster and global setting.' type: - boolean - 'null' x-go-name: OverrideGlobalNetgroupWhitelist overrideGlobalWhitelist: description: 'Specifies whether view level client subnet whitelist overrides cluster and global setting.' type: - boolean - 'null' x-go-name: OverrideGlobalWhitelist protocolAccess: description: 'Specifies the supported Protocols for the View. ''kAll'' enables protocol access to following three views: NFS, SMB and S3. ''kNFSOnly'' enables protocol access to NFS only. ''kSMBOnly'' enables protocol access to SMB only. ''kS3Only'' enables protocol access to S3 only. ''kSwiftOnly'' enables protocol access to Swift only.' type: - string - 'null' enum: - kAll - kNFSOnly - kSMBOnly - kS3Only - kSwiftOnly x-go-name: ProtocolAccess qos: description: Specifies the Quality of Service (QoS) Policy for the View. $ref: '#/components/schemas/QoS' securityMode: description: 'Specifies the security mode used for this view. Currently we support the following modes: Native, Unified and NTFS style. ''kNativeMode'' indicates a native security mode. ''kUnifiedMode'' indicates a unified security mode. ''kNtfsMode'' indicates a NTFS style security mode.' type: - string - 'null' enum: - kNativeMode - kUnifiedMode - kNtfsMode x-go-name: SecurityMode sharePermissions: description: Specifies a list of share level permissions. type: - array - 'null' items: $ref: '#/components/schemas/SmbPermission' x-go-name: SharePermissions smbPermissionsInfo: description: Specifies the SMB permissions for the View. $ref: '#/components/schemas/SmbPermissionsInfo' storagePolicyOverride: description: 'Specifies if inline deduplication and compression settings inherited from the Storage Domain (View Box) should be disabled for this View.' $ref: '#/components/schemas/StoragePolicyOverride' subnetWhitelist: description: 'Array of Subnets. Specifies a list of Subnets with IP addresses that have permissions to access the View. (Overrides the Subnets specified at the global Cohesity Cluster level.)' type: - array - 'null' items: $ref: '#/components/schemas/Subnet' x-go-name: SubnetWhitelist swiftProjectDomain: description: Specifies the Keystone project domain. type: - string - 'null' x-go-name: SwiftProjectDomain swiftProjectName: description: Specifies the Keystone project name. type: - string - 'null' x-go-name: SwiftProjectName tenantId: description: Optional tenant id who has access to this View. type: - string - 'null' x-go-name: TenantId viewLockEnabled: description: 'Specifies whether view lock is enabled. If enabled the view cannot be modified or deleted until unlock. By default it is disabled.' type: - boolean - 'null' x-go-name: ViewLockEnabled x-go-package: cohesity/iris/server/data/public 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 DirQuotaConfig: description: Specifies the configuration object of a directory quota. type: object title: Directory Quota Configuration. properties: enabled: description: Specifies whether the directory quota is enabled on the view. type: - boolean - 'null' x-go-name: Enabled viewName: description: Specifies the name of the view. type: - string - 'null' x-go-name: ViewName x-go-package: cohesity/iris/server/data/public UserQuotaSummaryForView: description: Specifies the user quota summary information/result for a view. type: object title: User Quota Summary For View. properties: defaultUserQuotaPolicy: description: 'Default quota policy applied to all the users in the view who doesn''t have a policy override.' $ref: '#/components/schemas/QuotaPolicy' numUsersAboveAlertThreshold: description: Number of users who has exceeded their specified alert limit. type: - integer - 'null' format: int64 x-go-name: NumUsersAboveAlertThreshold numUsersAboveHardLimit: description: Number of users who has exceeded their specified quota hard limit. type: - integer - 'null' format: int64 x-go-name: NumUsersAboveHardLimit totalNumUsers: description: 'Total number of users who has either a user quota policy override specified or has non-zero logical usage.' type: - integer - 'null' format: int64 x-go-name: TotalNumUsers x-go-package: cohesity/iris/server/data/public CloneDirectoryParams: description: Specifies the params that have to be provided to clone a directory. type: object title: Clone Directory Request Params. properties: destinationDirectoryName: description: Name of the new directory which will contain the clone contents. type: - string - 'null' x-go-name: DestinationDirectoryName destinationParentDirectoryPath: description: 'Specifies the path of the destination parent directory. The source dir would be cloned as a child of destination parent dir.' type: - string - 'null' x-go-name: DestinationParentDirectoryPath sourceDirectoryPath: description: Specifies the path of the source directory type: - string - 'null' x-go-name: SourceDirectoryPath x-go-package: cohesity/iris/server/data/public GetViewsResult: description: 'Specifies the list of Views returned that matched the specified filter criteria.' type: object title: Get Views Result. properties: lastResult: description: 'If false, more Views are available to return. If the number of Views to return exceeds the number of Views specified in maxCount (default of 1000) of the original GET /public/views request, the first set of Views are returned and this field returns false. To get the next set of Views, in the next GET /public/views request send the last id from the previous viewList.' type: - boolean - 'null' x-go-name: LastResult views: description: 'Array of Views. Specifies the list of Views returned in this response. The list is sorted by decreasing View ids.' type: - array - 'null' items: $ref: '#/components/schemas/View' x-go-name: ViewList x-go-package: cohesity/iris/server/data/public CreateViewRequest: description: Specifies the information required for creating a new View. type: object title: Create View Request. required: - name - viewBoxId properties: accessSids: description: 'Array of Security Identifiers (SIDs) Specifies the list of security identifiers (SIDs) for the restricted Principals who have access to this View.' type: - array - 'null' items: type: string x-go-name: AccessSids antivirusScanConfig: description: Specifies the antivirus scan config settings for this View. $ref: '#/components/schemas/AntivirusScanConfig' 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 description: description: Specifies an optional text description about the View. type: - string - 'null' x-go-name: Description enableFastDurableHandle: description: 'Specifies whether fast durable handle is enabled. If enabled, view open handle will be kept in memory, which results in a higher performance. But the handles cannot be recovered if node or service crashes.' type: - boolean - 'null' x-go-name: EnableFastDurableHandle enableFilerAuditLogging: description: Specifies if Filer Audit Logging is enabled for this view. type: - boolean - 'null' x-go-name: EnableFilerAuditLogging enableLiveIndexing: description: Specifies whether to enable live indexing for the view. type: - boolean - 'null' x-go-name: EnableLiveIndexing enableMixedModePermissions: description: 'If set, mixed mode (NFS and SMB) access is enabled for this view. This field is deprecated. Use the field SecurityMode. deprecated: true' type: - boolean - 'null' x-go-name: EnableMixedModePermissions enableNfsViewDiscovery: description: If set, it enables discovery of view for NFS. type: - boolean - 'null' x-go-name: EnableNfsViewDiscovery enableOfflineCaching: description: Specifies whether to enable offline file caching of the view. type: - boolean - 'null' x-go-name: EnableOfflineCaching enableSmbAccessBasedEnumeration: description: 'Specifies if access-based enumeration should be enabled. If ''true'', only files and folders that the user has permissions to access are visible on the SMB share for that user.' type: - boolean - 'null' x-go-name: EnableSmbAccessBasedEnumeration enableSmbEncryption: description: 'Specifies the SMB encryption for the View. If set, it enables the SMB encryption for the View. Encryption is supported only by SMB 3.x dialects. Dialects that do not support would still access data in unencrypted format.' type: - boolean - 'null' x-go-name: EnableSmbEncryption enableSmbOplock: description: Specifies whether SMB opportunistic lock is enabled. type: - boolean - 'null' x-go-name: EnableSmbOplock enableSmbViewDiscovery: description: If set, it enables discovery of view for SMB. type: - boolean - 'null' x-go-name: EnableSmbViewDiscovery enforceSmbEncryption: description: 'Specifies the SMB encryption for all the sessions for the View. If set, encryption is enforced for all the sessions for the View. When enabled all future and existing unencrypted sessions are disallowed.' type: - boolean - 'null' x-go-name: EnforceSmbEncryption fileExtensionFilter: description: 'Optional filtering criteria that should be satisfied by all the files created in this view. It does not affect existing files.' $ref: '#/components/schemas/FileExtensionFilter' fileLockConfig: description: 'Optional config that enables file locking for this view. It cannot be disabled during the edit of a view, if it has been enabled during the creation of the view. Also, it cannot be enabled if it was disabled during the creation of the view.' $ref: '#/components/schemas/FileLevelDataLockConfig' logicalQuota: description: 'Specifies an optional logical quota limit (in bytes) for the usage allowed on this View. (Logical data is when the data is fully hydrated and expanded.) This limit overrides the limit inherited from the Storage Domain (View Box) (if set). If logicalQuota is nil, the limit is inherited from the Storage Domain (View Box) (if set). A new write is not allowed if the Storage Domain (View Box) will exceed the specified quota. However, it takes time for the Cohesity Cluster to calculate the usage across Nodes, so the limit may be exceeded by a small amount. In addition, if the limit is increased or data is removed, there may be a delay before the Cohesity Cluster allows more data to be written to the View, as the Cluster is calculating the usage across Nodes.' allOf: - $ref: '#/components/schemas/QuotaPolicy' name: description: Specifies the name of the new View to create. 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' 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' s3KeyMappingConfig: description: 'Specifies key mapping config of S3 storage. 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 smbPermissionsInfo: description: Specifies the SMB permissions for the View. $ref: '#/components/schemas/SmbPermissionsInfo' storagePolicyOverride: description: 'Specifies if inline deduplication and compression settings inherited from the Storage Domain (View Box) should be disabled for this View.' $ref: '#/components/schemas/StoragePolicyOverride' subnetWhitelist: description: 'Array of Subnets. Specifies a list of Subnets with IP addresses that have permissions to access the View. (Overrides the Subnets specified at the global Cohesity Cluster level.)' type: - array - 'null' items: $ref: '#/components/schemas/Subnet' x-go-name: SubnetWhitelist swiftProjectDomain: description: Specifies the Keystone project domain. type: - string - 'null' x-go-name: SwiftProjectDomain swiftProjectName: description: Specifies the Keystone project name. type: - string - 'null' x-go-name: SwiftProjectName 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 will be created.' type: - integer - 'null' format: int64 x-go-name: ViewBoxId viewLockEnabled: description: 'Specifies whether view lock is enabled. If enabled the view cannot be modified or deleted until unlock. By default it is disabled.' type: - boolean - 'null' x-go-name: ViewLockEnabled x-go-package: cohesity/iris/server/data/public 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 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 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 ViewUserQuotas: description: 'Specifies the Result parameters for all user quotas of a view.' type: object title: View User Quotas. properties: cookie: description: 'This cookie can be used in the succeeding call to list user quotas and usages to get the next set of user quota overrides. If set to nil, it means that there''s no more results that the server could provide.' type: - string - 'null' x-go-name: Cookie quotaAndUsageInAllViews: description: The quota and usage information for a user in all his views. type: - array - 'null' items: $ref: '#/components/schemas/QuotaAndUsageInView' x-go-name: QuotaAndUsageInAllViews summaryForUser: description: 'UserQuotaSummaryForUser is the summary for user quotas in all views for a user.' $ref: '#/components/schemas/UserQuotaSummaryForUser' summaryForView: description: UserQuotaSummaryForView is the summary for user quotas in a view. $ref: '#/components/schemas/UserQuotaSummaryForView' userQuotaSettings: description: The default user quota policy for this view. $ref: '#/components/schemas/UserQuotaSettings' usersQuotaAndUsage: description: The list of user quota policies/overrides and usages. type: - array - 'null' items: $ref: '#/components/schemas/UserQuotaAndUsage' x-go-name: UsersQuotaAndUsage x-go-package: cohesity/iris/server/data/public LockRange: type: object title: Specifies details of an entity lock. properties: isExclusive: type: - boolean - 'null' x-go-name: IsExclusive length: type: - integer - 'null' format: uint64 x-go-name: Length offset: type: - integer - 'null' format: uint64 x-go-name: Offset x-go-package: cohesity/iris/server/data/public UserQuotaSummaryForUser: description: Speifies the summary of quota information for a particular user. type: object title: User Quota Summary For User. properties: numViewsAboveAlertThreshold: description: Number of views in which user has exceeded alert threshold limit. type: - integer - 'null' format: uint32 x-go-name: NumViewsAboveAlertThreshold numViewsAboveHardLimit: description: Number of views in which the user has exceeded hard limit. type: - integer - 'null' format: uint32 x-go-name: NumViewsAboveHardLimit totalNumViews: description: 'Total number of views in which the user has a quota policy specified or has non-zero usage.' type: - integer - 'null' format: uint32 x-go-name: TotalNumViews 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 Share: description: 'Specifies the share details when request is made for list of shares filtered by ShareName parameter.' type: object title: Share. properties: allSmbMountPaths: description: 'Array of SMB Paths. Specifies the possible paths that can be used to mount this Share 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 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 nfsMountPath: description: Specifies the path for mounting this Share as an NFS share. type: - string - 'null' x-go-name: NfsMountPath path: description: Specifies the path information for this share. type: - string - 'null' x-go-name: Path s3AccessPath: description: Specifies the path to access this View as an S3 share. type: - string - 'null' x-go-name: S3AccessPath shareName: description: The name of the share. type: - string - 'null' x-go-name: ShareName 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 Share as an SMB share. type: - string - 'null' x-go-name: SmbMountPath 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 tenantId: description: Specifies the unique id of the tenant. type: - string - 'null' x-go-name: TenantId viewName: description: Specifies the view name this share belongs to. type: - string - 'null' x-go-name: ViewName x-go-package: cohesity/iris/server/data/public QoSPolicy: description: Specifies the Quality of Service (QoS) Policy details. type: object title: QoSPolicy. properties: alwaysUseSsd: description: Specifies whether to always write to SSD even if SeqWriteSsdPct is 0. type: - boolean - 'null' x-go-name: AlwaysUseSsd id: description: Specifies Id of the QoS Policy. type: - integer - 'null' format: int64 x-go-name: Id minRequests: description: 'Specifies minimum number of requests, corresponding to this Policy, executed in the QoS queue.' type: - integer - 'null' format: int32 x-go-name: MinRequests name: description: Specifies Name of the Qos Policy. type: - string - 'null' x-go-name: Name priority: description: 'Specifies Priority of the Qos Policy. Priority of QoS Policy as defined in cluster config proto.' type: - string - 'null' enum: - kLow - kHigh x-go-name: Priority randomWriteHydraPct: description: 'Specifies percentage of a random write request belonging to this Policy that hits hydra.' type: - integer - 'null' format: int32 x-go-name: RandomWriteHydraPct randomWriteSsdPct: description: 'Specifies percentage of a random write request belonging to this Policy that hits SSD.' type: - integer - 'null' format: int32 x-go-name: RandomWriteSsdPct seqWriteHydraPct: description: 'Specifies percentage of a sequential write request belonging to this Policy that hits hydra.' type: - integer - 'null' format: int32 x-go-name: SeqWriteHydraPct seqWriteSsdPct: description: 'Specifies percentage of a sequential write request belonging to this Policy that hits SSD.' type: - integer - 'null' format: int32 x-go-name: SeqWriteSsdPct weight: description: Specifies Weight of the QoS Policy used in QoS queue. type: - integer - 'null' format: int32 x-go-name: Weight workLoadType: description: Specifies Workload type attribute associated with this Policy. type: - string - 'null' x-go-name: WorkloadType 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 UpdateDirQuotaArgs: description: 'Specifies the arguments for updating the directory quota policies. This structure can be used for adding, updating and removing the policies.' type: object title: Update Directory Quota Policies Arguments. properties: disableDirQuota: description: Specifies directory quota to be disabled on the view. type: - boolean - 'null' x-go-name: DisableDirQuota quota: description: Specifies a directory quota policy to be updated. $ref: '#/components/schemas/DirQuotaPolicy' viewName: description: Specifies the name of the view. type: - string - 'null' x-go-name: ViewName 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 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 ClearNlmLocksParameters: description: Specifies parameters required to force clear NLM Locks. type: object title: Clear NLM Locks Parameters. properties: clientId: description: Specifies the id of the client, related NLM locks needs to be clear. type: - string - 'null' x-go-name: ClientId filePath: description: 'Specifies the filepath in the view relative to the root filesystem. If this field is specified, viewName field must also be specified.' type: - string - 'null' x-go-name: FilePath viewName: description: 'Specifies the name of the View in which to search. If a view name is not specified, all the views in the Cluster is searched. This field is mandatory if filePath field is specified.' type: - string - 'null' x-go-name: ViewName x-go-package: cohesity/iris/server/data/public UpdateViewAliasParam: description: Specifies the parameters of updating view alias op. type: object title: UpdateViewAliasParam. properties: aliasName: description: Name of the alias to be updated. 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 x-go-package: cohesity/iris/server/data/public NlmLock: description: 'Response map as received from view-keeper is converted into this structure. These Locks belong to one file-path.' type: object title: Specifies a NLM lock. properties: clientId: description: Specifies the client ID type: - string - 'null' x-go-name: ClientId lockRanges: type: - array - 'null' items: $ref: '#/components/schemas/LockRange' x-go-name: LockRanges 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 FileLockStatus: description: Specifies the information of lock status for a file. type: object title: File Lock Status. properties: expiryTimestampMsecs: description: Specifies a expiry timestamp in milliseconds until the file is locked. type: - integer - 'null' format: int64 x-go-name: ExpiryTimestampMsecs holdTimestampMsecs: description: 'Specifies a override timestamp in milliseconds when an expired file is kept on hold.' type: - integer - 'null' format: int64 x-go-name: HoldTimestampMsecs lockTimestampMsecs: description: Specifies the timestamp at which the file was locked. type: - integer - 'null' format: int64 x-go-name: LockedTimestampMsecs mode: description: 'Specifies the mode of the file lock. ''kCompliance'', ''kEnterprise''. 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 state: description: Specifies the lock state of the file. type: - integer - 'null' format: int32 x-go-name: State 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 ViewUserQuotaParameters: description: Specifies the params to create and edit a user quota policy in a view. type: object title: View User Quota Parameters. properties: userQuotaPolicy: description: The user quota policies that need to be updated. $ref: '#/components/schemas/UserQuota' viewName: description: View name of input view. type: - string - 'null' x-go-name: ViewName 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 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 DirQuotaPolicy: description: 'Specifies a policy configuration for the directory quota. A policy is the sole entity which describes the usage limits of a directory in a view. `DirPath` is the identifier of a policy. It must be specified for adding, updating or removing a policy. If `Policy` is not set, then it is considered to be removed.' type: object title: Directory Quota Policy. properties: dirPath: description: Specifies the path of the directory in the view. type: - string - 'null' x-go-name: DirPath dirWalkPending: description: Denotes directory quota walk is pending or not. type: - boolean - 'null' x-go-name: DirWalkPending policy: description: Specifies the quota policy to be applied to the directory. $ref: '#/components/schemas/QuotaPolicy' usageBytes: description: 'Specifies the current usage (in bytes) by the directory in the view. This is set by the response received from bridge when querying directory quota usage.' type: - integer - 'null' format: int64 x-go-name: UsageBytes x-go-package: cohesity/iris/server/data/public GetViewsByShareNameResult: description: 'Specifies the list of Views and Aliases by share name that matched the specified filter criteria.' type: object title: Get (Views and Aliases) By Share Result. properties: paginationCookie: description: 'If set, i.e. there are more results to display, use this value to get the next set of results, by using this value in paginationCookie param for the next request to GetViewsByShare.' type: - string - 'null' x-go-name: PaginationCookie sharesList: description: 'Array of Views and Aliases by Share name. Specifies the list of Views returned in this response.' type: - array - 'null' items: $ref: '#/components/schemas/Share' x-go-name: SharesList x-go-package: cohesity/iris/server/data/public CloneViewRequest: description: Specifies the settings for cloning an existing View. type: object title: Clone View Request. properties: accessSids: description: 'Array of Security Identifiers (SIDs) Specifies the list of security identifiers (SIDs) for the restricted Principals who have access to this View.' type: - array - 'null' items: type: string x-go-name: AccessSids antivirusScanConfig: description: Specifies the antivirus scan config settings for this View. $ref: '#/components/schemas/AntivirusScanConfig' cloneViewName: description: Specifies the name of the new View that is cloned from the source View. type: - string - 'null' x-go-name: CloneViewName dataLockExpiryUsecs: description: 'DataLock (Write Once Read Many) lock expiry epoch time in microseconds. If specified, a view will be marked as a DataLock view. If a view is marked as a DataLock view, only a Data Security Officer (a user having Data Security Privilege) can delete the view until the lock expiry time.' type: - integer - 'null' format: int64 x-go-name: DataLockExpiryUsecs description: description: Specifies an optional text description about the View. type: - string - 'null' x-go-name: Description enableFastDurableHandle: description: 'Specifies whether fast durable handle is enabled. If enabled, view open handle will be kept in memory, which results in a higher performance. But the handles cannot be recovered if node or service crashes.' type: - boolean - 'null' x-go-name: EnableFastDurableHandle enableFilerAuditLogging: description: Specifies if Filer Audit Logging is enabled for this view. type: - boolean - 'null' x-go-name: EnableFilerAuditLogging enableLiveIndexing: description: Specifies whether to enable live indexing for the view. type: - boolean - 'null' x-go-name: EnableLiveIndexing enableMixedModePermissions: description: 'If set, mixed mode (NFS and SMB) access is enabled for this view. This field is deprecated. Use the field SecurityMode. deprecated: true' type: - boolean - 'null' x-go-name: EnableMixedModePermissions enableNfsViewDiscovery: description: If set, it enables discovery of view for NFS. type: - boolean - 'null' x-go-name: EnableNfsViewDiscovery enableOfflineCaching: description: Specifies whether to enable offline file caching of the view. type: - boolean - 'null' x-go-name: EnableOfflineCaching enableSmbAccessBasedEnumeration: description: 'Specifies if access-based enumeration should be enabled. If ''true'', only files and folders that the user has permissions to access are visible on the SMB share for that user.' type: - boolean - 'null' x-go-name: EnableSmbAccessBasedEnumeration enableSmbEncryption: description: 'Specifies the SMB encryption for the View. If set, it enables the SMB encryption for the View. Encryption is supported only by SMB 3.x dialects. Dialects that do not support would still access data in unencrypted format.' type: - boolean - 'null' x-go-name: EnableSmbEncryption enableSmbOplock: description: Specifies whether SMB opportunistic lock is enabled. type: - boolean - 'null' x-go-name: EnableSmbOplock enableSmbViewDiscovery: description: If set, it enables discovery of view for SMB. type: - boolean - 'null' x-go-name: EnableSmbViewDiscovery enforceSmbEncryption: description: 'Specifies the SMB encryption for all the sessions for the View. If set, encryption is enforced for all the sessions for the View. When enabled all future and existing unencrypted sessions are disallowed.' type: - boolean - 'null' x-go-name: EnforceSmbEncryption fileExtensionFilter: description: 'Optional filtering criteria that should be satisfied by all the files created in this view. It does not affect existing files.' $ref: '#/components/schemas/FileExtensionFilter' fileLockConfig: description: 'Optional config that enables file locking for this view. It cannot be disabled during the edit of a view, if it has been enabled during the creation of the view. Also, it cannot be enabled if it was disabled during the creation of the view.' $ref: '#/components/schemas/FileLevelDataLockConfig' logicalQuota: description: 'Specifies an optional logical quota limit (in bytes) for the usage allowed on this View. (Logical data is when the data is fully hydrated and expanded.) This limit overrides the limit inherited from the Storage Domain (View Box) (if set). If logicalQuota is nil, the limit is inherited from the Storage Domain (View Box) (if set). A new write is not allowed if the Storage Domain (View Box) will exceed the specified quota. However, it takes time for the Cohesity Cluster to calculate the usage across Nodes, so the limit may be exceeded by a small amount. In addition, if the limit is increased or data is removed, there may be a delay before the Cohesity Cluster allows more data to be written to the View, as the Cluster is calculating the usage across Nodes.' allOf: - $ref: '#/components/schemas/QuotaPolicy' netgroupWhitelist: description: 'Array of Netgroups. Specifies a list of Netgroups that have permissions to access the View. (Overrides the Netgroups specified at the global Cohesity Cluster level.)' type: - array - 'null' items: $ref: '#/components/schemas/NisNetgroup' x-go-name: NetgroupWhitelist nfsAllSquash: description: Specifies the NFS all squash config. $ref: '#/components/schemas/NfsSquash' nfsRootPermissions: description: Specifies the NFS root permission config of the view file system. $ref: '#/components/schemas/NfsRootPermissions' nfsRootSquash: description: Specifies the NFS root squash config. $ref: '#/components/schemas/NfsSquash' overrideGlobalNetgroupWhitelist: description: 'Specifies whether view level client netgroup whitelist overrides cluster and global setting.' type: - boolean - 'null' x-go-name: OverrideGlobalNetgroupWhitelist overrideGlobalWhitelist: description: 'Specifies whether view level client subnet whitelist overrides cluster and global setting.' type: - boolean - 'null' x-go-name: OverrideGlobalWhitelist protocolAccess: description: 'Specifies the supported Protocols for the View. ''kAll'' enables protocol access to following three views: NFS, SMB and S3. ''kNFSOnly'' enables protocol access to NFS only. ''kSMBOnly'' enables protocol access to SMB only. ''kS3Only'' enables protocol access to S3 only. ''kSwiftOnly'' enables protocol access to Swift only.' type: - string - 'null' enum: - kAll - kNFSOnly - kSMBOnly - kS3Only - kSwiftOnly x-go-name: ProtocolAccess qos: description: Specifies the Quality of Service (QoS) Policy for the View. $ref: '#/components/schemas/QoS' securityMode: description: 'Specifies the security mode used for this view. Currently we support the following modes: Native, Unified and NTFS style. ''kNativeMode'' indicates a native security mode. ''kUnifiedMode'' indicates a unified security mode. ''kNtfsMode'' indicates a NTFS style security mode.' type: - string - 'null' enum: - kNativeMode - kUnifiedMode - kNtfsMode x-go-name: SecurityMode sharePermissions: description: Specifies a list of share level permissions. type: - array - 'null' items: $ref: '#/components/schemas/SmbPermission' x-go-name: SharePermissions smbPermissionsInfo: description: Specifies the SMB permissions for the View. $ref: '#/components/schemas/SmbPermissionsInfo' sourceViewName: description: Specifies the name of the source View that will be cloned. type: - string - 'null' x-go-name: SourceViewName storagePolicyOverride: description: 'Specifies if inline deduplication and compression settings inherited from the Storage Domain (View Box) should be disabled for this View.' $ref: '#/components/schemas/StoragePolicyOverride' subnetWhitelist: description: 'Array of Subnets. Specifies a list of Subnets with IP addresses that have permissions to access the View. (Overrides the Subnets specified at the global Cohesity Cluster level.)' type: - array - 'null' items: $ref: '#/components/schemas/Subnet' x-go-name: SubnetWhitelist swiftProjectDomain: description: Specifies the Keystone project domain. type: - string - 'null' x-go-name: SwiftProjectDomain swiftProjectName: description: Specifies the Keystone project name. type: - string - 'null' x-go-name: SwiftProjectName tenantId: description: Optional tenant id who has access to this View. type: - string - 'null' x-go-name: TenantId viewLockEnabled: description: 'Specifies whether view lock is enabled. If enabled the view cannot be modified or deleted until unlock. By default it is disabled.' type: - boolean - 'null' x-go-name: ViewLockEnabled x-go-package: cohesity/iris/server/data/public DirQuotaInfo: description: 'Specifies the configuration and policy details for directory quota in a view.' type: object title: Directory Quota Info. properties: config: description: Specifies the directory quota configuration. $ref: '#/components/schemas/DirQuotaConfig' quotas: description: Specifies the list of directory quota policies applied on the view. type: - array - 'null' items: $ref: '#/components/schemas/DirQuotaPolicy' x-go-name: Quotas x-go-package: cohesity/iris/server/data/public ListNlmLocksResponse: description: Query response to list of NLM locks. type: object title: List of NLM locks response. properties: cookie: description: 'Specifies an opaque string to pass to get the next set of NLM locks. If null is returned, this response is the last set of NLM locks.' type: - string - 'null' x-go-name: Cookie filesNlmLocks: description: Specifies the list of NLM locks. type: - array - 'null' items: $ref: '#/components/schemas/FileNlmLocks' x-go-name: FilesNlmLocks x-go-package: cohesity/iris/server/data/public UserQuotaAndUsage: description: 'Specifies the quota override and usage statistics for a particular user.' type: object title: User Quota And Usage. properties: quotaPolicy: description: User quota policy applied to this user. $ref: '#/components/schemas/QuotaPolicy' sid: description: 'If interested in a user via smb_client, include SID. Otherwise, If a valid unix-id to SID mappings are available (i.e., when mixed mode is enabled) the server will perform the necessary id mapping and return the correct usage irrespective of whether the unix id / SID is provided. The string is of following format - S-1-IdentifierAuthority-SubAuthority1-SubAuthority2-...-SubAuthorityn.' type: - string - 'null' x-go-name: Sid unixUid: description: 'If interested in a user via unix-identifier, include UnixUid. Otherwise, If a valid unix-id to SID mappings are available (i.e., when mixed mode is enabled) the server will perform the necessary id mapping and return the correct usage irrespective of whether the unix id / SID is provided.' type: - integer - 'null' format: uint32 x-go-name: UnixUid usageBytes: description: Current logical usage of user id in the input view. type: - integer - 'null' format: int64 x-go-name: UsageBytes 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 UserQuota: description: Specifies the quota policy applied to a user. type: object title: User Quota Policy. properties: quotaPolicy: description: User quota policy applied to this user. $ref: '#/components/schemas/QuotaPolicy' sid: description: 'If interested in a user via smb_client, include SID. Otherwise, If a valid unix-id to SID mappings are available (i.e., when mixed mode is enabled) the server will perform the necessary id mapping and return the correct usage irrespective of whether the unix id / SID is provided. The string is of following format - S-1-IdentifierAuthority-SubAuthority1-SubAuthority2-...-SubAuthorityn.' type: - string - 'null' x-go-name: Sid unixUid: description: 'If interested in a user via unix-identifier, include UnixUid. Otherwise, If a valid unix-id to SID mappings are available (i.e., when mixed mode is enabled) the server will perform the necessary id mapping and return the correct usage irrespective of whether the unix id / SID is provided.' type: - integer - 'null' format: uint32 x-go-name: UnixUid x-go-package: cohesity/iris/server/data/public FileId: type: object title: Specifies the file Identifier. A file is identified with these three Ids. properties: entityId: description: Specifies the entity id of the file. type: - integer - 'null' format: int64 x-go-name: EntityId rootInodeId: description: Specifies the root inode id of the file system that file belongs to. type: - integer - 'null' format: int64 x-go-name: RootInodeId viewId: description: Specifies the id of the View the file belongs to. type: - integer - 'null' format: int64 x-go-name: ViewId x-go-package: cohesity/iris/server/data/public SmbConnection: type: object properties: clientIp: description: Specifies the Client IP address of the connection. type: - string - 'null' x-go-name: ClientIp domainName: description: Domain name of the corresponding user. type: - string - 'null' x-go-name: DomainName nodeIp: description: Specifies a Node IP address where the connection request is received. type: - string - 'null' x-go-name: NodeIp path: description: Mount path. type: - string - 'null' x-go-name: Path serverIp: description: 'Specifies the Server IP address of the connection. This could be a VIP, VLAN IP, or node IP on the Cluster.' type: - string - 'null' x-go-name: ServerIp sessionId: description: Session id. type: - integer - 'null' format: int64 x-go-name: SessionId sids: description: List of SIDs in the SMB session token. type: - array - 'null' items: type: string x-go-name: Sids userName: description: User name used to login for this session. type: - string - 'null' x-go-name: UserName viewId: description: Specifies the id of the view. type: - integer - 'null' format: int64 x-go-name: ViewId viewName: description: Specifies the name of the view. type: - string - 'null' x-go-name: ViewName x-go-package: cohesity/iris/server/data/public UserId: description: Specifies the mapping between an Unix and an SMB SID. type: object title: User ID. properties: sid: description: 'If interested in a user via smb_client, include SID. Otherwise, If a valid unix-id to SID mappings are available (i.e., when mixed mode is enabled) the server will perform the necessary id mapping and return the correct usage irrespective of whether the unix id / SID is provided. The string is of following format - S-1-IdentifierAuthority-SubAuthority1-SubAuthority2-...-SubAuthorityn.' type: - string - 'null' x-go-name: Sid unixUid: description: 'If interested in a user via unix-identifier, include UnixUid. Otherwise, If a valid unix-id to SID mappings are available (i.e., when mixed mode is enabled) the server will perform the necessary id mapping and return the correct usage irrespective of whether the unix id / SID is provided.' type: - integer - 'null' format: uint32 x-go-name: UnixUid x-go-package: cohesity/iris/server/data/public LockFileParams: description: Specifies the parameters to lock a file in a view. type: object title: Lock File Parameters. properties: expiryTimestampMsecs: description: 'Specifies a definite timestamp in milliseconds for retaining the file, or to extend it''s expiry timestamp.' type: - integer - 'null' format: uint64 x-go-name: ExpiryTimestampMsecs path: description: Specifies the file path that needs to be locked. type: - string - 'null' x-go-name: Path 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 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 DeleteViewUsersQuotaParameters: description: Specifies the user ids to remove the corresponding quota overrides in view. type: object title: Delete View Users Quota Parameters. properties: deleteAll: description: Delete all existing user quota override policies. type: - boolean - 'null' x-go-name: DeleteAll userIds: description: The user ids whose policy needs to be deleted. type: - array - 'null' items: $ref: '#/components/schemas/UserId' x-go-name: UserIds viewName: description: View name of input view. type: - string - 'null' x-go-name: ViewName x-go-package: cohesity/iris/server/data/public QuotaAndUsageInView: description: Specifies the usage and quota information for a specific view. type: object title: Quota And Usage In View. properties: quota: description: User quota policy applied to this user. $ref: '#/components/schemas/QuotaPolicy' usageBytes: description: Usage in bytes of this user in this view. type: - integer - 'null' format: int64 x-go-name: UsageBytes viewId: description: The usage and quota policy information of this user for this view. type: - integer - 'null' format: int64 x-go-name: ViewId viewName: description: View name. type: - string - 'null' x-go-name: ViewName 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 ViewPinningConfig: description: Specifies the pinning config of a view. type: object required: - enabled properties: enabled: description: Specifies if view pinning is enabled. If set to true, view will be pinned to SSD and view data will be stored there. type: - boolean - 'null' x-order: 0 pinnedTimeSecs: description: Specifies the time to pin files after last access. type: - integer - 'null' format: int64 x-order: 1 lastUpdatedTimestampSecs: description: Specifies the timestamp when view pinning config is last updated. type: - integer - 'null' format: int64 x-order: 2 readOnly: true FileLevelDataLockConfig_2: 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: autoLockAfterDurationIdleMsecs: 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-order: 0 defaultRetentionDurationMsecs: 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-order: 1 expiryTimestampMsecs: description: Specifies a definite timestamp in milliseconds for retaining the file. type: - integer - 'null' format: uint64 x-order: 2 lockingProtocol: description: 'Specifies the supported mechanisms to explicity lock a file from NFS/SMB interface. Supported locking protocols: SetReadOnly, SetAtime. ''SetReadOnly'' 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. ''SetAtime'' is compatible with Data Domain behaviour.' type: - string - 'null' enum: - SetReadOnly - SetAtime x-order: 3 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-order: 4 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-order: 5 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. Compliance: 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. Enterprise: 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: ''Compliance'': 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 ''Compliance'' mode.' type: - string - 'null' enum: - Compliance - Enterprise x-order: 6 NfsSquash_2: 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-order: 0 uid: description: UID mapped for all clients. type: - integer - 'null' format: uint32 x-order: 1 DataUsageStats_2: 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-order: 0 cloudDataWrittenBytesTimestampUsec: description: Specifies Timestamp of CloudDataWrittenBytes. type: - integer - 'null' format: int64 x-order: 1 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-order: 2 cloudTotalPhysicalUsageBytesTimestampUsec: description: Specifies Timestamp of CloudTotalPhysicalUsageBytes. type: - integer - 'null' format: int64 x-order: 3 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-order: 4 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-order: 5 dataInBytesAfterDedupTimestampUsec: description: Specifies Timestamp of DataInBytesAfterDedup. type: - integer - 'null' format: int64 x-order: 6 dataInBytesTimestampUsec: description: Specifies Timestamp of DataInBytes. type: - integer - 'null' format: int64 x-order: 7 dataProtectLogicalUsageBytes: description: Specifies the logical data used by Data Protect on Cohesity cluster. type: - integer - 'null' format: int64 x-order: 8 dataProtectLogicalUsageBytesTimestampUsec: description: Specifies Timestamp of DataProtectLogicalUsageBytes. type: - integer - 'null' format: int64 x-order: 9 dataProtectPhysicalUsageBytes: description: Specifies the physical data used by Data Protect on Cohesity cluster. type: - integer - 'null' format: int64 x-order: 10 dataProtectPhysicalUsageBytesTimestampUsec: description: Specifies Timestamp of DataProtectPhysicalUsageBytes. type: - integer - 'null' format: int64 x-order: 11 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-order: 12 dataWrittenBytesTimestampUsec: description: Specifies Timestamp of DataWrittenBytes. type: - integer - 'null' format: int64 x-order: 13 fileServicesLogicalUsageBytes: description: Specifies the logical data used by File services on Cohesity cluster. type: - integer - 'null' format: int64 x-order: 14 fileServicesLogicalUsageBytesTimestampUsec: description: Specifies Timestamp of FileServicesLogicalUsageBytes. type: - integer - 'null' format: int64 x-order: 15 fileServicesPhysicalUsageBytes: description: Specifies the physical data used by File services on Cohesity cluster. type: - integer - 'null' format: int64 x-order: 16 fileServicesPhysicalUsageBytesTimestampUsec: description: Specifies Timestamp of FileServicesPhysicalUsageBytes. type: - integer - 'null' format: int64 x-order: 17 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-order: 18 localDataWrittenBytesTimestampUsec: description: Specifies Timestamp of LocalDataWrittenBytes. type: - integer - 'null' format: int64 x-order: 19 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-order: 20 localTierResiliencyImpactBytesTimestampUsec: description: Specifies Timestamp of LocalTierResiliencyImpactBytes. type: - integer - 'null' format: int64 x-order: 21 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-order: 22 localTotalPhysicalUsageBytesTimestampUsec: description: Specifies Timestamp of LocalTotalPhysicalUsageBytes. type: - integer - 'null' format: int64 x-order: 23 outdatedLogicalUsageBytes: description: 'Specifies the logical usage as computed by the Cohesity Cluster. This field is computed on a same frequency as ''StorageConsumedBytes'', and it may not be the latest value. It is used to compute reduction ratio.' type: - integer - 'null' format: int64 x-order: 24 outdatedLogicalUsageBytesTimestampUsec: description: Specifies Timestamp of OutdatedLogicalUsageBytes. type: - integer - 'null' format: int64 x-order: 25 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-order: 26 storageConsumedBytesTimestampUsec: description: Specifies Timestamp of StorageConsumedBytes. type: - integer - 'null' format: int64 x-order: 27 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-order: 28 totalLogicalUsageBytesTimestampUsec: description: Specifies Timestamp of TotalLogicalUsageBytes. type: - integer - 'null' format: int64 x-order: 29 uniquePhysicalDataBytes: description: Specifies the unique physical data usage in bytes. type: - integer - 'null' format: int64 x-order: 30 CreateView: description: Specifies the information required for creating a new View w/o required fields. type: object title: Create View. allOf: - type: object properties: storageDomainId: description: 'Specifies the id of the Storage Domain (View Box) where the View will be created.' type: - integer - 'null' format: int64 x-order: 0 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-order: 1 objectServicesMappingConfig: description: 'Specifies the Object Services key mapping config of the view. This parameter can only be set during create and cannot be changed. Configuration of Object Services key mapping. Specifies the type of Object Services key mapping config.' type: - string - 'null' enum: - Random - Short - Long - Hierarchical x-order: 2 viewProtectionConfig: description: Specifies the protection config of the View. allOf: - $ref: '#/components/schemas/ViewProtectionConfig' - {} x-order: 3 - $ref: '#/components/schemas/UpdateViewParam_2' ViewAliasInfo: description: View Alias Info is returned as part of list views. type: object title: View Alias Information. properties: aliasName: description: Alias name. type: - string - 'null' x-order: 0 viewPath: description: View path for the alias. type: - string - 'null' x-order: 1 smbConfig: description: SMB config for the alias (share). allOf: - $ref: '#/components/schemas/AliasSmbConfig' - {} x-order: 2 clientSubnetWhitelist: description: List of external client subnet IPs that are allowed to access the share. type: - array - 'null' items: $ref: '#/components/schemas/Subnet_2' x-order: 3 Template: description: Description of the view template. type: object title: Template. properties: id: description: Specifies an id of the view template. type: - integer - 'null' format: int64 x-order: 0 readOnly: true name: description: Specifies the name of the view template. type: - string - 'null' x-order: 1 dedup: description: Specifies whether to enable dedup in storage domain. type: - boolean - 'null' x-order: 2 compress: description: Specifies whether to enable compression in storage domain. type: - boolean - 'null' x-order: 3 isDefault: description: Specifies if the tempate is custom or static. type: - boolean - 'null' x-order: 4 readOnly: true defaultTemplateName: description: Used for uniquely indentifying a default template. type: - string - 'null' enum: - Unknown - BackupGeneral - BackupCommvault - BackupVeeam - FileServiceVideos - FileServiceMultimedia - FileServiceArchive - ObjectServiceContainer x-order: 5 readOnly: true viewParams: description: 'Specifies the parameters which is used to create the view. No field is required.' allOf: - $ref: '#/components/schemas/CreateView' - {} x-order: 6 SwiftConfig: description: Specifies the Swift config settings for this View. type: object properties: swiftProjectDomain: description: Specifies the Keystone project domain. type: - string - 'null' x-order: 0 swiftProjectName: description: Specifies the Keystone project name. type: - string - 'null' x-order: 1 swiftUserDomain: description: Specifies the Keystone user domain. type: - string - 'null' x-order: 2 swiftUsername: description: Specifies the Keystone username. type: - string - 'null' x-order: 3 ViewStats_2: description: Provides statistics about the View. type: object title: View Stats. properties: id: description: Specifies the id of the View. type: - integer - 'null' format: int64 x-order: 0 dataUsageStats: description: Specifies the data usage metric of the data stored in this View. allOf: - $ref: '#/components/schemas/DataUsageStats_2' - {} x-order: 1 readOnly: true ExistingGroupParam: description: Specifies the parameters for using existing protection group. type: object required: - id properties: id: description: Specifies the protection group id. type: - string - 'null' x-order: 0 ViewFailover: description: Specifies the failover status of a view. type: object properties: isFailoverReady: description: Specifies if the view is ready for failover. type: - boolean - 'null' x-order: 0 remoteViewId: description: Specifies the remote view id. type: - integer - 'null' format: int64 x-order: 1 remoteClusterId: description: Specifies the remote cluster id. type: - integer - 'null' format: int64 x-order: 2 remoteClusterIncarnationId: description: Specifies the remote cluster incarnation id. type: - integer - 'null' format: int64 x-order: 3 StoragePolicyOverride_2: description: 'Specifies if inline deduplication and compression settings inherited from Storage Domain (View Box) should be disabled for this View.' type: - object - 'null' 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-order: 0 disableDedup: description: 'If it is set to true, we would disable dedup for writes made in this view irrespective of the view box''s storage policy.' type: - boolean - 'null' x-order: 1 S3Config: description: Specifies the S3 config settings for this View. type: object properties: s3AccessPath: description: Specifies the path to access this View as an S3 share. type: - string - 'null' x-order: 0 readOnly: true NfsRootPermissions_2: 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-order: 0 mode: description: Unix mode bits for the root of the file system. type: - integer - 'null' format: uint32 x-order: 1 uid: description: Unix UID for the root of the file system. type: - integer - 'null' format: uint32 x-order: 2 NisNetgroup_2: description: Specifies an NIS netgroup. type: object required: - name - domain properties: name: description: Specifies the netgroup name. type: - string - 'null' x-order: 0 domain: description: Specifies the domain name for the netgroup. type: - string - 'null' x-order: 1 nfsAccess: description: Specifies NFS protocol acess level for clients from the netgroup. type: - string - 'null' enum: - kDisabled - kReadOnly - kReadWrite x-order: 2 nfsSquash: description: 'Specifies which nfsSquash Mounted. ''kNone'' mounts none. ''kRootSquash'' mounts nfsRootSquash. Whether clients from this subnet can mount as root on NFS. ''kAllSquash'' mounts nfsAllSquash. Whether all clients from this subnet can map view with view_all_squash_uid/view_all_squash_gid configured in the view.' type: - string - 'null' enum: - kNone - kRootSquash - kAllSquash x-order: 3 Subnet_2: 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-order: 0 description: description: Description of the subnet. type: - string - 'null' x-order: 1 gateway: description: Gateway for the subnet. type: - string - 'null' x-order: 2 id: description: ID of the subnet. type: - integer - 'null' format: int32 x-order: 3 ip: description: Specifies either an IPv6 address or an IPv4 address. type: - string - 'null' x-order: 4 netmaskBits: description: Specifies the netmask using bits. type: - integer - 'null' format: int32 x-order: 5 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-order: 6 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-order: 7 nfsSquash: description: 'Specifies which nfsSquash Mounted. ''kNone'' mounts none. ''kRootSquash'' mounts nfsRootSquash. Whether clients from this subnet can mount as root on NFS. ''kAllSquash'' mounts nfsAllSquash. Whether all clients from this subnet can map view with view_all_squash_uid/view_all_squash_gid configured in the view.' type: - string - 'null' enum: - kNone - kRootSquash - kAllSquash x-order: 8 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-order: 9 s3Access: description: 'Specifies whether clients from this subnet can access using S3 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-order: 10 ProtectionGroupInfo: description: Specifies basic information about a Protection Group. type: object title: Protection Group Info properties: groupId: description: Specifies the id of the Protection Group. type: - integer - 'null' format: int64 x-order: 0 groupName: description: Specifies the name of the Protection Group. type: - string - 'null' x-order: 1 type: description: 'Specifies the type of the Protection Group such as View or Puppeteer. ''Puppeteer'' refers to a Remote Adapter Group. Supported environment types such as ''View'', ''SQL'', ''VMware'', etc. NOTE: ''Puppeteer'' refers to Cohesity''s Remote Adapter. ''VMware'' indicates the VMware Protection Source environment. ''HyperV'' indicates the HyperV Protection Source environment. ''SQL'' indicates the SQL Protection Source environment. ''View'' indicates the View Protection Source environment. ''Puppeteer'' indicates the Cohesity''s Remote Adapter. ''Physical'' indicates the physical Protection Source environment. ''Pure'' indicates the Pure Storage Protection Source environment. ''Nimble'' indicates the Nimble Storage Protection Source environment. ''Azure'' indicates the Microsoft''s Azure Protection Source environment. ''Netapp'' indicates the Netapp Protection Source environment. ''Agent'' indicates the Agent Protection Source environment. ''GenericNas'' indicates the Generic Network Attached Storage Protection Source environment. ''Acropolis'' indicates the Acropolis Protection Source environment. ''PhsicalFiles'' indicates the Physical Files Protection Source environment. ''Isilon'' indicates the Dell EMC''s Isilon Protection Source environment. ''GPFS'' indicates IBM''s GPFS Protection Source environment. ''KVM'' indicates the KVM Protection Source environment. ''AWS'' indicates the AWS Protection Source environment. ''Exchange'' indicates the Exchange Protection Source environment. ''HyperVVSS'' indicates the HyperV VSS Protection Source environment. ''Oracle'' indicates the Oracle Protection Source environment. ''GCP'' indicates the Google Cloud Platform Protection Source environment. ''FlashBlade'' indicates the Flash Blade Protection Source environment. ''AWSNative'' indicates the AWS Native Protection Source environment. ''O365'' indicates the Office 365 Protection Source environment. ''O365Outlook'' indicates Office 365 outlook Protection Source environment. ''HyperFlex'' indicates the Hyper Flex Protection Source environment. ''GCPNative'' indicates the GCP Native Protection Source environment. ''AzureNative'' indicates the Azure Native Protection Source environment. ''Kubernetes'' indicates a Kubernetes Protection Source environment. ''Elastifile'' indicates Elastifile Protection Source environment. ''AD'' indicates Active Directory Protection Source environment.' type: - string - 'null' enum: - kVMware - kHyperV - kSQL - kView - kRemoteAdapter - kPhysical - kPure - kAzure - kNetapp - kGenericNas - kAcropolis - kIsilon - kKVM - kAWS - kExchange - kOracle - kGCP - kFlashBlade - kO365 - kHyperFlex - kAD - kGPFS - kKubernetes - kNimble - kElastifile - kCassandra - kMongoDB - kCouchbase - kHdfs - kHive - kHBase - kUDA x-order: 2 AliasSmbConfig: description: 'Message defining SMB config for IRIS. SMB config contains SMB encryption flags, SMB discoverable flag and Share level permissions.' type: object properties: discoveryEnabled: description: Whether the share is discoverable. type: - boolean - 'null' x-order: 0 encryptionEnabled: description: 'Whether SMB encryption is enabled for this share. 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-order: 1 encryptionRequired: description: 'Whether to enforce encryption for all the sessions for this view. When enabled all unencrypted sessions are disallowed.' type: - boolean - 'null' x-order: 2 permissions: description: Share level permissions. type: - array - 'null' items: $ref: '#/components/schemas/SmbPermission_2' x-order: 3 superUserSids: description: Specifies a list of super user sids. type: - array - 'null' items: type: string x-order: 4 cachingEnabled: description: Indicate if offline file caching is supported type: - boolean - 'null' x-order: 5 isShareLevelPermissionEmpty: description: Indicate if share level permission is cleared by user. type: - boolean - 'null' x-order: 6 oplockEnabled: description: Indicate the operation lock is enabled by this view. type: - boolean - 'null' x-order: 7 continuousAvailability: description: 'Whether file open handles are persited to scribe to survive bridge process crash. When set to false, open handles will be kept in memory untill the current node has exclusive ticket for the entity handle. When the entity is opened from another node, the exclusive ticket would be revoked from the node. In revoke control flow, the current node would persist the state to scribe. On acquiring the exclusive ticket,another node would read the file open handles from scribe and resume the handling of operation.' type: - boolean - 'null' x-order: 8 ViewProtocol: description: Specifies the protocol options for view. type: object title: Protocol Option properties: type: description: "Type of protocol.\nSpecifies the supported Protocols for the View.\n 'NFS' enables protocol access to NFS v3.\n 'NFS4' enables protocol access to NFS v4.1.\n 'SMB' enables protocol access to SMB.\n 'S3' enables protocol access to S3.\n 'Swift' enables protocol access to Swift." type: string enum: - NFS - NFS4 - SMB - S3 - Swift x-order: 0 mode: description: "Mode of protocol access.\n 'ReadOnly'\n 'ReadWrite'" type: string enum: - ReadOnly - ReadWrite x-order: 1 SmbPermission_2: description: Specifies information about a single SMB permission. type: object title: SMB Permission. properties: type: description: 'Specifies the type of permission. ''Allow'' indicates access is allowed. ''Deny'' indicates access is denied. ''SpecialType'' indicates a type defined in the Access Control Entry (ACE) does not map to ''Allow'' or ''Deny''.' type: - string - 'null' enum: - Allow - Deny - SpecialType x-order: 0 mode: description: 'Specifies how the permission should be applied to folders and/or files. ''FolderSubFoldersAndFiles'' indicates that permissions are applied to a Folder and it''s sub folders and files. ''FolderAndSubFolders'' indicates that permissions are applied to a Folder and it''s sub folders. ''FolderAndSubFiles'' indicates that permissions are applied to a Folder and it''s sub files. ''FolderOnly'' indicates that permsission are applied to folder only. ''SubFoldersAndFilesOnly'' indicates that permissions are applied to sub folders and files only. ''SubFoldersOnly'' indicates that permissiona are applied to sub folders only. ''FilesOnly'' indicates that permissions are applied to files only.' type: - string - 'null' enum: - FolderSubFoldersAndFiles - FolderAndSubFolders - FolderAndFiles - FolderOnly - SubFoldersAndFilesOnly - SubFoldersOnly - FilesOnly x-order: 1 access: description: "Specifies the read/write access to the SMB share.\n'ReadyOnly' indicates read only access to the SMB share.\n'ReadWrite' indicates read and write access to the SMB share.\n'FullControl' indicates full administrative control of the SMB share.\n'SpecialAccess' indicates custom permissions to the SMB share using\n access masks structures.\n'SuperUser' indicates root permissions ignoring all SMB ACLs." type: - string - 'null' enum: - ReadOnly - ReadWrite - Modify - FullControl - SpecialAccess x-order: 2 sid: description: Specifies the security identifier (SID) of the principal. type: - string - 'null' x-order: 3 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-order: 4 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-order: 5 QuotaPolicy_2: description: 'Specifies a quota limit that can be optionally applied to Views and Storage Domains. At the View level, this quota defines a logical limit for usage on the View. At the Storage Domain level, this quota defines a physical limit or a default logical View limit. If a physical quota is specified for Storage Domain, this quota defines a physical limit for the usage on the Storage Domain. If a default logical View quota is specified for Storage Domain, this limit is inherited by all the Views in that Storage Domain. 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-order: 0 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-order: 1 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-order: 2 ViewProtectionConfig: description: Specifies the View protection config. type: object required: - protectionGroupType properties: protectionGroupType: description: Specifies the View protection group type. type: - string - 'null' enum: - ExistingGroup - NewGroup x-order: 0 existingGroupParam: description: Specifies the parameters used for existing protection group. allOf: - $ref: '#/components/schemas/ExistingGroupParam' - {} x-order: 1 newGroupParam: description: Specifies the parameters used for new protection group. allOf: - $ref: '#/components/schemas/NewGroupParam' - {} x-order: 2 NisNetgroups: description: Response of NIS Netgroups. type: object properties: nisNetgroups: description: A list of NIS Netgroups. type: - array - 'null' items: $ref: '#/components/schemas/NisNetgroup_2' x-order: 0 UpdateViewParam_2: description: 'Specifies the settings that define a View. Common fields between create, edit and response struct.' type: object allOf: - type: object properties: name: description: Specifies the name of the View. type: - string - 'null' x-order: 0 category: description: Specifies the category of the View. type: - string - 'null' enum: - BackupTarget - FileServices - ObjectServices x-order: 1 protocolAccess: description: Specifies the supported Protocols for the View. type: - array - 'null' items: $ref: '#/components/schemas/ViewProtocol' x-order: 2 qos: description: Specifies the Quality of Service (QoS) Policy for the View. allOf: - $ref: '#/components/schemas/QoS_2' - {} x-order: 3 overrideGlobalSubnetWhitelist: description: 'Specifies whether view level client subnet whitelist overrides cluster and global setting.' type: - boolean - 'null' x-order: 4 subnetWhitelist: description: 'Array of Subnets. Specifies a list of Subnets with IP addresses that have permissions to access the View. (Overrides or extends the Subnets specified at the global Cohesity Cluster level.)' type: - array - 'null' items: $ref: '#/components/schemas/Subnet_2' x-order: 5 overrideGlobalNetgroupWhitelist: description: 'Specifies whether view level client netgroup whitelist overrides cluster and global setting.' type: - boolean - 'null' x-order: 6 netgroupWhitelist: description: 'Array of Netgroups. Specifies a list of netgroups with domains that have permissions to access the View. (Overrides or extends the Netgroup specified at the global Cohesity Cluster level.)' allOf: - $ref: '#/components/schemas/NisNetgroups' - {} x-order: 7 securityMode: description: 'Specifies the security mode used for this view. Currently we support the following modes: Native, Unified and NTFS style. ''NativeMode'' indicates a native security mode. ''UnifiedMode'' indicates a unified security mode. ''NtfsMode'' indicates a NTFS style security mode.' type: - string - 'null' enum: - NativeMode - UnifiedMode - NtfsMode x-order: 8 storagePolicyOverride: description: 'Specifies if inline deduplication and compression settings inherited from the Storage Domain (View Box) should be disabled for this View.' allOf: - $ref: '#/components/schemas/StoragePolicyOverride_2' - {} x-order: 9 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_2' - {} x-order: 10 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.' allOf: - $ref: '#/components/schemas/FileLevelDataLockConfig_2' - {} x-order: 11 fileExtensionFilter: description: 'Optional filtering criteria that should be satisfied by all the files created in this view. It does not affect existing files.' allOf: - $ref: '#/components/schemas/FileExtensionFilter_2' - {} x-order: 12 antivirusScanConfig: description: Specifies the antivirus scan config settings for this View. allOf: - $ref: '#/components/schemas/AntivirusScanConfig_2' - {} x-order: 13 description: description: Specifies an optional text description about the View. type: - string - 'null' x-order: 14 allowMountOnWindows: description: 'Specifies if this View can be mounted using the NFS protocol on Windows systems. If true, this View can be NFS mounted on Windows systems.' type: - boolean - 'null' x-order: 15 enableMinion: description: 'Specifies if this view should allow minion or not. If true, this will allow minion.' type: - boolean - 'null' x-order: 16 enableFilerAuditLogging: description: Specifies if Filer Audit Logging is enabled for this view. type: - boolean - 'null' x-order: 17 tenantId: description: Optional tenant id who has access to this View. type: - string - 'null' x-order: 18 enableLiveIndexing: description: Specifies whether to enable live indexing for the view. type: - boolean - 'null' x-order: 19 enableOfflineCaching: description: Specifies whether to enable offline file caching of the view. type: - boolean - 'null' x-order: 20 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-order: 21 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-order: 22 isReadOnly: description: Specifies if the view is a read only view. User will no longer be able to write to this view if this is set to true. type: - boolean - 'null' x-order: 23 viewPinningConfig: description: Specifies the pinning config of this view. allOf: - $ref: '#/components/schemas/ViewPinningConfig' - {} x-order: 24 selfServiceSnapshotConfig: description: Specifies self service config of this view. type: object allOf: - $ref: '#/components/schemas/SelfServiceSnapshotConfig' - {} x-order: 25 - $ref: '#/components/schemas/NfsConfig' - $ref: '#/components/schemas/SmbConfig' - $ref: '#/components/schemas/S3Config' - $ref: '#/components/schemas/SwiftConfig' AntivirusScanConfig_2: 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-order: 0 isEnabled: description: Specifies whether the antivirus service is enabled or not. type: - boolean - 'null' x-order: 1 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-order: 2 scanFilter: description: 'Files extension that meets these filter criteria will be sent to antivirus server for the scan.' allOf: - $ref: '#/components/schemas/FileExtensionFilter_2' - {} x-order: 3 scanOnAccess: description: Specifies whether to scan a file when it is opened. type: - boolean - 'null' x-order: 4 scanOnClose: description: Specifies whether to scan a file when it is closed after modify. type: - boolean - 'null' x-order: 5 scanTimeoutUsecs: description: 'Specifies the maximum amount of time that a scan can take before timing out.' type: - integer - 'null' format: int32 x-order: 6 ViewSharePermissions: description: Specifies share permissions of the view. type: object properties: superUserSids: description: Specifies a list of super user sids. type: - array - 'null' items: type: string x-order: 0 permissions: description: Specifies a list of share permissions. type: - array - 'null' items: $ref: '#/components/schemas/SmbPermission_2' x-order: 1 SmbPermissionsInfo_2: 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-order: 0 permissions: description: 'Array of SMB Permissions. Specifies a list of SMB permissions.' type: - array - 'null' items: $ref: '#/components/schemas/SmbPermission_2' x-order: 1 NewGroupParam: description: Specifies the parameters for using a new protection group. type: object required: - name - policyId - storageDomainId properties: name: description: Specifies the name of the new protection group. type: - string - 'null' x-order: 0 policyId: description: Specifies the policy id of the new protection group. type: - string - 'null' x-order: 1 storageDomainId: description: Specifies the storage domain id of the new protection group. type: - integer - 'null' format: int64 x-order: 2 View_2: 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. allOf: - type: object required: - protocolAccess - qos properties: viewId: description: Specifies an id of the View assigned by the Cohesity Cluster. type: - integer - 'null' format: int64 x-order: 0 readOnly: true isCategoryInferred: description: "If True, category in response is not set by user but inferred by\nIris because none is set. Category can only be none when view was\ncreated by v1 API or cloned from a view created by v1 API.\n\nInference Logic is as follows:\n1. Object Services if only S3 or Swift protocol is selected.\n2. Backup Target only if one read-write protocol is selected and\n QoS is \"Backup Target Commvault\" or \"Backup Target SSD\".\n3. File Services if there are more than 1 read-write protocol or\n it doesn't fit any other category." type: - boolean - 'null' x-order: 1 readOnly: true 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-order: 2 objectServicesMappingConfig: description: 'Specifies the Object Services key mapping config of the view. This parameter can only be set during create and cannot be changed. Configuration of Object Services key mapping. Specifies the type of Object Services key mapping config.' type: - string - 'null' enum: - Random - Short - Long - Hierarchical x-order: 3 readOnly: true storageDomainId: description: 'Specifies the id of the Storage Domain (View Box) where the View is stored.' type: - integer - 'null' format: int64 x-order: 4 readOnly: true storageDomainName: description: 'Specifies the name of the Storage Domain (View Box) where the View is stored.' type: - string - 'null' x-order: 5 readOnly: true 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-order: 6 readOnly: true createTimeMsecs: description: Specifies the time that the View was created in milliseconds. type: - integer - 'null' format: int64 x-order: 7 readOnly: true 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-order: 8 readOnly: true nfsMountPath: description: 'This field is currently deprecated. Please use NFS MountPaths which would be an array of strings.' type: - string - 'null' x-order: 9 readOnly: true nfsMountPaths: description: "Array of NFS Paths.\nSpecifies the path for mounting this View as an NFS share. If\nKerberos Provider has multiple hostaliases, each host alias has\n its own path." type: - array - 'null' items: type: string x-order: 10 readOnly: true smbMountPaths: 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-order: 11 readOnly: true viewProtection: allOf: - $ref: '#/components/schemas/ViewProtection_2' - {} x-order: 12 readOnly: true 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/ViewAliasInfo' x-order: 13 readOnly: true isTargetForMigratedData: description: Specifies if a view contains migrated data. type: - boolean - 'null' x-order: 14 readOnly: true viewFailover: description: 'Specifies the information about the failover of the view.' allOf: - $ref: '#/components/schemas/ViewFailover' - {} x-order: 15 readOnly: true stats: description: Specifies statistics about the View. allOf: - $ref: '#/components/schemas/ViewStats_2' - {} x-order: 16 readOnly: true - $ref: '#/components/schemas/UpdateViewParam_2' QoS_2: 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-order: 0 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-order: 1 SelfServiceSnapshotConfig: description: Specifies the self service snapshot config of a view. type: object properties: enabled: description: Specifies if self service snapshot feature is enabled. If this is set to true, the feature will also be enabled for NFS protocol. This field is deprecated. type: - boolean - 'null' x-order: 0 previousVersionsEnabled: description: Specifies if previouse versions feature is enabled with SMB protocol. type: - boolean - 'null' x-order: 1 nfsAccessEnabled: description: Specifies if self service snapshot feature is enabled for NFS protocol. type: - boolean - 'null' x-order: 2 smbAccessEnabled: description: Specifies if self service snapshot feature is enabled for SMB protocol. type: - boolean - 'null' x-order: 3 snapshotDirectoryName: description: Specifies the directory name for the snapshots. type: - string - 'null' x-order: 4 alternateSnapshotDirectoryName: description: Specifies the alternate directory name for the snapshots. If it is not set, this feature for SMB protocol will not work. type: - string - 'null' x-order: 5 allowAccessSids: description: Specifies a list of sids who has access to the snapshots. type: array items: type: string x-omitempty: true x-order: 6 denyAccessSids: description: Specifies a list of sids who does not have access to the snapshots. This field overrides 'allowAccessSids'. type: array items: type: string x-omitempty: true x-order: 7 GetViewTemplatesResult: description: 'Specifies the list of view template returned that matched the specified filter criteria.' type: object title: Get view templates Result. properties: Templates: description: 'Array of view template. Specifies the list of view templates returned in this response.' type: - array - 'null' items: $ref: '#/components/schemas/Template' x-order: 0 Error: description: Specifies the error object with error code and a message. type: object title: Error. properties: errorCode: description: Specifies the error code. type: - string - 'null' x-order: 0 message: description: Specifies the error message. type: - string - 'null' x-order: 1 SmbConfig: description: Specifies the SMB config settings for this View. type: - object - 'null' properties: enableSmbViewDiscovery: description: If set, it enables discovery of view for SMB. type: - boolean - 'null' x-order: 0 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-order: 1 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-order: 2 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-order: 3 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-order: 4 enableSmbOplock: description: Specifies whether SMB opportunistic lock is enabled. type: - boolean - 'null' x-order: 5 smbPermissionsInfo: description: Specifies the SMB permissions for the View. allOf: - $ref: '#/components/schemas/SmbPermissionsInfo_2' - {} x-order: 6 sharePermissions: description: Specifies share level permissions of the view. type: object allOf: - $ref: '#/components/schemas/ViewSharePermissions' - {} x-order: 7 ViewProtection_2: description: 'Specifies information about the Protection Groups that are protecting the View.' type: object title: View Protection. properties: magnetoEntityId: description: Specifies the id of the Protection Source that is using this View. type: - integer - 'null' format: int64 x-order: 0 protectionGroups: description: 'Array of Protection Group. Specifies the Protection Group that are protecting the View.' type: - array - 'null' items: $ref: '#/components/schemas/ProtectionGroupInfo' x-order: 1 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-order: 2 readOnly: true GetViewsResult_2: description: 'Specifies the list of Views returned that matched the specified filter criteria.' type: object title: Get Views Result. properties: views: description: 'Array of Views. Specifies the list of Views returned in this response. The list is sorted by decreasing View ids.' type: - array - 'null' items: $ref: '#/components/schemas/View_2' x-order: 0 lastResult: description: 'If false, more Views are available to return. If the number of Views to return exceeds the number of Views specified in maxCount (default of 1000) of the original GET /public/views request, the first set of Views are returned and this field returns false. To get the next set of Views, in the next GET /public/views request send the last id from the previous viewList.' type: - boolean - 'null' x-order: 1 count: description: 'Number of views returned. This will only be returned if ViewCountOnly is set in arguments.' type: - integer - 'null' format: int64 x-order: 2 NfsConfig: description: Specifies the NFS config settings for this View. type: object properties: enableNfsViewDiscovery: description: If set, it enables discovery of view for NFS. type: - boolean - 'null' x-order: 0 nfsAllSquash: description: Specifies the NFS all squash config. allOf: - $ref: '#/components/schemas/NfsSquash_2' - {} x-order: 1 nfsRootPermissions: description: Specifies the NFS root permission config of the view file system. allOf: - $ref: '#/components/schemas/NfsRootPermissions_2' - {} x-order: 2 nfsRootSquash: description: Specifies the NFS root squash config. allOf: - $ref: '#/components/schemas/NfsSquash_2' - {} x-order: 3 enableNfsUnixAuthentication: description: If set, it enables NFS UNIX Authentication type: - boolean - 'null' x-order: 4 enableNfsKerberosAuthentication: description: If set, it enables NFS Kerberos Authentication type: - boolean - 'null' x-order: 5 enableNfsKerberosIntegrity: description: If set, it enables NFS Kerberos Integrity type: - boolean - 'null' x-order: 6 enableNfsKerberosPrivacy: description: If set, it enables NFS Kerberos Privacy type: - boolean - 'null' x-order: 7 CreateViewRequest_2: description: Specifies the information required for creating a new View. type: object title: Create View Request. allOf: - $ref: '#/components/schemas/CreateView' - type: object required: - name - category - storageDomainId - protocolAccess - qos FileExtensionFilter_2: type: object properties: fileExtensionsList: description: The list of file extensions to apply type: - array - 'null' items: type: string x-order: 0 isEnabled: description: If set, it enables the file extension filter type: - boolean - 'null' x-order: 1 mode: description: 'The mode applied to the list of file extensions ''Whitelist'' indicates a whitelist extension filter. ''Blacklist'' indicates a blacklist extension filter.' type: - string - 'null' enum: - Whitelist - Blacklist x-order: 2 securitySchemes: APIKeyHeader: in: header name: apiKey type: apiKey x-refined-from: - cohesity-cluster-v1-openapi-original.yml - cohesity-cluster-v2-openapi-original.yml