Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 22 additions & 16 deletions docs/cmdlets-reference/find-cohesityfilesnapshot.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,26 @@
# Find-CohesityFileSnapshot

## SYNOPSIS
Get the information about snapshots that contain the specified file or folder. In addition, information about the file or folder is provided.
Get the information about snapshots that contain the specified file or folder.
In addition, information about the file or folder is provided.

## SYNTAX

```
Find-CohesityFileSnapshot [-ClusterId <Int64>] [-ClusterIncarnationId <Int64>] [-FileName <String>] [-JobId <Int64>]
[-SourceId <Int64>] [<CommonParameters>]
Find-CohesityFileSnapshot [[-FileName] <String>] [-JobId] <Int64> [-SourceId] <Int64> [<CommonParameters>]
```

## DESCRIPTION
Get the information about snapshots that contain the specified file or folder.
In addition, information about the file or folder is provided.

## EXAMPLES

### EXAMPLE 1
```
Find-CohesityFileSnapshot -FileName "abc.txt" -SourceId 123 -JobId 11
```

Returns snapshot information of specified file/folder in metioned source.

## PARAMETERS

### -FileName
Expand All @@ -30,15 +32,15 @@ Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -JobId
Specifies the id of the Job that captured the snapshots.
Specifies the name of the Restore Task.Specifies the id of the Job that captured the snapshots.
These snapshots are searched for the specified files or folders.
This field is required.

Expand All @@ -48,26 +50,26 @@ Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### -SourceId
Specifies the id of the Protection Source object (such as a VM) to search.
When a Job Run executes, snapshots of the specified Protection Source
object are captured. This operation searches the snapshots of the
object for the file or folder. This field is required.
When a Job Run executes, snapshots of the specified Protection Source object are captured.
This operation searches the snapshots of the object for the file or folder.
This field is required.

```yaml
Type: Int64
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
Expand All @@ -79,7 +81,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## OUTPUTS

### Cohesity.Model.FileSnapshotInformation
### System.Array
## NOTES
Published by Cohesity

## RELATED LINKS

[https://cohesity.github.io/cohesity-powershell-module/#/README](https://cohesity.github.io/cohesity-powershell-module/#/README)

29 changes: 18 additions & 11 deletions docs/cmdlets-reference/find-cohesityobjectsnapshot.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
# Find-CohesityObjectSnapshot

## SYNOPSIS
List the snapshots for a given object using cohesity v2 REST API.
List the snapshots for a given object.

## SYNTAX

```
Find-CohesityObjectSnapshot [-ObjectId <Int64>] [-JobId <String[]>] [<CommonParameters>]
Find-CohesityObjectSnapshot [-ObjectId] <String> [[-ProtectionGroupIds] <String[]>] [<CommonParameters>]
```

## DESCRIPTION
List the snapshots for a given object.

## EXAMPLES

### EXAMPLE 1
Expand All @@ -20,7 +23,7 @@ Returns list of snapshot information of specified object with id 12.

### EXAMPLE 2
```
Find-CohesityObjectSnapshot -ObjectId 12 -JobId 1111:2222:12
Find-CohesityObjectSnapshot -ObjectId 12 -ProtectionGroupIds 1111:2222:12
```

Returns list of snapshot information of specified object with id 12, which is protected through specified protection job.
Expand All @@ -31,27 +34,28 @@ Returns list of snapshot information of specified object with id 12, which is pr
Specifies the id of the Object.

```yaml
Type: Int64
Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -JobId
List of protection group id. If specified, this returns only the snapshots of the specified object ID, which belong to the provided protection group IDs.
### -ProtectionGroupIds
List of protection group id.
If specified, this returns only the snapshots of the specified object ID, which belong to the provided protection group IDs.

```yaml
Type: String
Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Expand All @@ -64,8 +68,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## OUTPUTS

### Cohesity.Model.ObjectSnapshot
### System.Array
## NOTES
Published by Cohesity

## RELATED LINKS
[Read More](https://cohesity.github.io/cohesity-powershell-module/#/README)

[https://cohesity.github.io/cohesity-powershell-module/#/README](https://cohesity.github.io/cohesity-powershell-module/#/README)

44 changes: 25 additions & 19 deletions docs/cmdlets-reference/find-cohesityremotefilesnapshot.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,32 @@
# Find-CohesityRemoteFileSnapshot

## SYNOPSIS
Get the information about snapshots from an external target that contain the specified file or folder. In addition, information about the file or folder is provided.
Get the information about snapshots from an external target that contain the specified file or folder.
In addition, information about the file or folder is provided.

## SYNTAX

```
Find-CohesityRemoteFileSnapshot [-DoNotIncludeIndexedSnapshotsOnly] [-FileName <String>] [-JobId <Int64>][-SourceId <Int64>] [<CommonParameters>]
Find-CohesityRemoteFileSnapshot [[-FileName] <String>] [-JobId] <Int64> [-SourceId] <Int64>
[-DoNotIncludeIndexedSnapshots] [<CommonParameters>]
```

## DESCRIPTION
Get the information about snapshots from an external target that contain the specified file or folder.
In addition, information about the file or folder is provided.

## EXAMPLES

### EXAMPLE 1
```
Find-CohesityRemoteFileSnapshot -FileName "abc.txt" -SourceId 123 -JobId 11
```

Returns indexed remote snapshot information of specified file/folder in metioned source.

### EXAMPLE 2
```
Find-CohesityRemoteFileSnapshot -FileName "abc.txt" -SourceId 123 -JobId 11 -DoNotIncludeIndexedSnapshots
```

Returns remote snapshot information of specified file/folder in metioned source, that are not indexed.

## PARAMETERS

### -FileName
Expand All @@ -36,15 +38,15 @@ Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -JobId
Specifies the id of the Job that captured the snapshots.
Specifies the name of the Restore Task.Specifies the id of the Job that captured the snapshots.
These snapshots are searched for the specified files or folders.
This field is required.

Expand All @@ -54,32 +56,33 @@ Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### -SourceId
Specifies the id of the Protection Source object (such as a VM) to search.
When a Job Run executes, snapshots of the specified Protection Source
object are captured. This operation searches the snapshots of the
object for the file or folder. This field is required.
When a Job Run executes, snapshots of the specified Protection Source object are captured.
This operation searches the snapshots of the object for the file or folder.
This field is required.

```yaml
Type: Int64
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### -DoNotIncludeIndexedSnapshots
Specifies whether to return indexed snapshots or not. In an indexed snapshot files are guaranteed to exist, while in a non-indexed snapshot files may not exist.
Specifies whether to return indexed snapshots or not.
In an indexed snapshots file are guaranteed to exist, while in a non-indexed snapshots file may not exist.

```yaml
Type: SwitchParameter
Expand All @@ -100,8 +103,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## OUTPUTS

### Cohesity.Model.IndexedObjectSnapshot
### System.Array
## NOTES
Published by Cohesity

## RELATED LINKS
[Read More](https://cohesity.github.io/cohesity-powershell-module/#/README)

[https://cohesity.github.io/cohesity-powershell-module/#/README](https://cohesity.github.io/cohesity-powershell-module/#/README)

1 change: 1 addition & 0 deletions docs/cmdlets-reference/get-cohesityprotectionjobrun.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## OUTPUTS

### System.Array
### System.Object[]
## NOTES
Published by Cohesity

Expand Down
17 changes: 16 additions & 1 deletion docs/cmdlets-reference/get-cohesityprotectionjobstatus.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Gets the protection job status.
## SYNTAX

```
Get-CohesityProtectionJobStatus [<CommonParameters>]
Get-CohesityProtectionJobStatus [-ReturnObject] [<CommonParameters>]
```

## DESCRIPTION
Expand All @@ -21,6 +21,21 @@ Get-CohesityProtectionJobStatus

## PARAMETERS

### -ReturnObject
Return Output as Object

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

Expand Down
2 changes: 1 addition & 1 deletion docs/cmdlets-reference/new-cohesityprotectionjob.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ Aliases:

Required: False
Position: Named
Default value: 4/19/2023 12:34:48 AM
Default value: 9/1/2026 10:08:33 PM
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
2 changes: 1 addition & 1 deletion docs/cmdlets-reference/new-cohesityuser.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ Aliases:

Required: False
Position: Named
Default value: 4/19/2023 12:34:49 AM
Default value: 9/1/2026 10:08:33 PM
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The HyperV type can be a SCVMM server or HyperV Host.

```
Register-CohesityProtectionSourceHyperV [-Server] <String> -HyperVType <Object> [-Credentials <PSCredential>]
[<CommonParameters>]
[-ReturnObject] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -77,6 +77,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -ReturnObject
Set to true, if result need to returned in object format

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,13 @@ Accept wildcard characters: False
Type of host.
Must be set to KLinux or KWindows.

Possible values: KLinux, KWindows, KAix, KSolaris, KSapHana, KSapOracle, KCockroachDB, KMySQL, KOther
Possible values: KLinux, KWindows, KAix, KSolaris, KSapHana, KSapOracle, KCockroachDB, KMySQL, KOther, KSapSybase, KSapMaxDB, KSapSybaseIQ, KDB2, KSapASE, KMariaDB, KPostgreSQL, KVOS, KHPUX

```yaml
Type: HostTypeEnum
Parameter Sets: (All)
Aliases:
Accepted values: KLinux, KWindows, KAix, KSolaris, KSapHana, KSapOracle, KCockroachDB, KMySQL, KOther
Accepted values: KLinux, KWindows, KAix, KSolaris, KSapHana, KSapOracle, KCockroachDB, KMySQL, KOther, KSapSybase, KSapMaxDB, KSapSybaseIQ, KDB2, KSapASE, KMariaDB, KPostgreSQL, KVOS, KHPUX

Required: True
Position: Named
Expand Down
Loading
Loading