Cohesity.Powershell.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Cohesity.PowerShell.Core</name> </assembly> <members> <member name="T:Cohesity.Powershell.Cmdlets.Agent.GetCohesityPhysicalAgent"> <summary> <para type="synopsis"> Gets a list of the registered physical agents with their information. </para> <para type="description"> Gets a list of the registered physical agents with their information. </para> </summary> <example> <para>PS></para> <code> Get-CohesityPhysicalAgent </code> <para> Gets a list of the registered physical agents with their information. </para> </example> </member> <member name="T:Cohesity.Powershell.Cmdlets.Agent.UpdateCohesityPhysicalAgent"> <summary> <para type="synopsis"> Upgrades the Cohesity agent on a Physical server registered with Cohesity. </para> <para type="description"> Upgrades the Cohesity agent on a Physical server registered with Cohesity. </para> </summary> <example> <para>PS></para> <code> Update-CohesityPhysicalAgent -Id 12 </code> <para> Upgrades the physical agent with the specified Id. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Agent.UpdateCohesityPhysicalAgent.Id"> <summary> <para type="description"> Specifies a unique id of the physical agent. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Agent.UpdateCohesityPhysicalAgent.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Agent.UpdateCohesityPhysicalAgent.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Cluster.GetCohesityAlert"> <summary> <para type="synopsis"> Gets a list of alerts triggered on the Cohesity Cluster filtered by the specified parameters. </para> <para type="description"> Gets a list of alerts triggered on the Cohesity Cluster filtered by the specified parameters. </para> </summary> <example> <para>PS></para> <code> Get-CohesityAlert -MaxAlerts 10 </code> <para> Gets a list of most recent 10 alerts triggered on the Cohesity Cluster. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Cluster.GetCohesityAlert.MaxAlerts"> <summary> <para type="description"> Limit the number of alerts to the specified value. The newest alerts are returned upto the limit specified. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Cluster.GetCohesityAlert.AlertCategories"> <summary> <para type="description"> Filter by a list of alert categories such as 'kDisk’, 'kNode’, 'kCluster’, 'kNodeHealth’, 'kClusterHealth’, 'kBackupRestore’, ‘kEncryption’ and 'kArchivalRestore’. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Cluster.GetCohesityAlert.AlertStates"> <summary> <para type="description"> Filter by a list of alert states such as ‘kOpen’ and 'kResolved’. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Cluster.GetCohesityAlert.AlertSeverities"> <summary> <para type="description"> Filter by a list of alert severities such as 'kCritical’, ‘kWarning’ and 'kInfo’. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Cluster.GetCohesityAlert.ResolutionIds"> <summary> <para type="description"> Filter by a list of resolution Ids. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Cluster.GetCohesityAlert.AlertIds"> <summary> <para type="description"> Filter by a list of alert Ids. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Cluster.GetCohesityAlert.AlertTypes"> <summary> <para type="description"> Filter by a list of alert types. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Cluster.GetCohesityAlert.StartTime"> <summary> <para type="description"> Filter by start date and time by specifying a unix epoch time in microseconds. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Cluster.GetCohesityAlert.EndTime"> <summary> <para type="description"> Filter by end date and time by specifying a unix epoch time in microseconds. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Cluster.GetCohesityAlert.ProcessRecord"> <summary> Process Records </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Cluster.ConnectCohesityCluster"> <summary> <para type="synopsis"> Connects to a Cohesity Cluster and acquires an authentication token. </para> <para type="description"> You must run this cmdlet with valid Cohesity credentials before any other Cohesity cmdlets. The subsequent Cohesity cmdlets will use this connection. The connection is valid for 24 hours. </para> </summary> <example> <para>PS></para> <code> Connect-CohesityCluster -Server 192.168.1.100 -Credential (Get-Credential) </code> <para> Connects to a Cohesity Cluster at the address "192.168.1.100" using the provided credentials. </para> </example> <example> <para>PS></para> <code> Connect-CohesityCluster -Server 192.168.1.100 -Credential (New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList "mydomain.com\admin", (ConvertTo-SecureString -AsPlainText "p@ssword" -Force)) </code> <para> Connects to a Cohesity Cluster at the address "192.168.1.100" using the active directory user, by appending domain name(mydomain.com) to the user. </para> </example> <example> <para>PS></para> <code> Connect-CohesityCluster -Server 192.168.1.100 -Credential (New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList "LOCAL\user1@tenant1", (ConvertTo-SecureString -AsPlainText "p@ssword" -Force)) </code> <para> Connects to a Cohesity Cluster at the address "192.168.1.100" for a user "user1" in the tenant "tenant1". </para> </example> <example> <para>PS></para> <code> Connect-CohesityCluster -Server 192.168.1.100 -APIKey "00000000-0000-0000-0000-000000000000" </code> <para> Connects to a Cohesity Cluster at the address "192.168.1.100" using the API Key (supported 6.5.1d onwards). </para> </example> </member> <member name="M:Cohesity.Powershell.Cmdlets.Cluster.ConnectCohesityCluster.#ctor"> <summary> Construct the cmdlet. </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Cluster.ConnectCohesityCluster.Server"> <summary> <para type="description"> The FQDN or IP address of any node in the Cohesity Cluster or Cluster VIP. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Cluster.ConnectCohesityCluster.Port"> <summary> <para type="description"> The port to use to connect to Cohesity Cluster. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Cluster.ConnectCohesityCluster.Credential"> <summary> <para type="description"> User credentials for the Cohesity Cluster. To login as a tenant use the user name as LOCAL\user1@tenant1 </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Cluster.ConnectCohesityCluster.APIKey"> <summary> <para type="description"> Cohesity API key </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Cluster.ConnectCohesityCluster.BeginProcessing"> <summary> Begin processing. </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Cluster.ConnectCohesityCluster.ProcessRecord"> <summary> Process Records </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Cluster.DisconnectCohesityCluster"> <summary> <para type="synopsis"> Disconnects from the Cohesity Cluster. </para> <para type="description"> Disconnects from the Cohesity Cluster and invalidates the session. </para> </summary> <example> <para>PS></para> <code> Disconnect-CohesityCluster </code> <para> Disconnects from the Cohesity Cluster and invalidates the session. </para> </example> </member> <member name="M:Cohesity.Powershell.Cmdlets.Cluster.DisconnectCohesityCluster.#ctor"> <summary> Construct the cmdlet. </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Cluster.DisconnectCohesityCluster.ProcessRecord"> <summary> Process Records </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Cluster.GetCohesityCluster"> <summary> <para type="synopsis"> Gets basic information about the Cohesity Cluster. </para> <para type="description"> Gets basic information about the Cohesity Cluster. </para> </summary> <example> <para>PS></para> <code> Get-CohesityCluster </code> <para> Gets basic information about the Cohesity Cluster. </para> </example> </member> <member name="M:Cohesity.Powershell.Cmdlets.Cluster.GetCohesityCluster.ProcessRecord"> <summary> Process Records </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Cluster.GetCohesityClusterConfiguration"> <summary> <para type="synopsis"> Gets the Cohesity Cluster configuration. </para> <para type="description"> If FetchStats parameter is specified, returns stats along with the Cohesity Cluster configuration. </para> </summary> <example> <para>PS></para> <code> Get-CohesityClusterConfiguration -FetchStats </code> <para> Returns stats along with the Cohesity Cluster configuration. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Cluster.GetCohesityClusterConfiguration.FetchStats"> <summary> <para type="description"> If specified, also gets stats along with the Cohesity Cluster configuration. </para> </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Cluster.GetCohesityClusterPartition"> <summary> <para type="synopsis"> Gets a list of partitions in the Cohesity Cluster. </para> <para type="description"> Gets a list of partitions in the Cohesity Cluster. </para> </summary> <example> <para>PS></para> <code> Get-CohesityClusterPartition </code> <para> Gets a list of partitions in the Cohesity Cluster. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Cluster.GetCohesityClusterPartition.Ids"> <summary> <para type="description"> Filter by a list of cluster partition ids. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Cluster.GetCohesityClusterPartition.Names"> <summary> <para type="description"> Filter by a list of cluster partition names. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Cluster.GetCohesityClusterPartition.ProcessRecord"> <summary> Process Records </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Cluster.SetCohesityClusterConfiguration"> <summary> <para type="synopsis"> Updates the Cohesity Cluster configuration. </para> <para type="description"> Returns the Updated Cohesity Cluster configuration. </para> </summary> <example> <para>PS></para> <code> $config = Get-CohesityClusterConfiguration $config.AssignedRacksCount = 10 Set-CohesityClusterConfiguration -ClusterConfiguration $config </code> <para> Updates the Cohesity Cluster configuration with specified parameters. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Cluster.SetCohesityClusterConfiguration.ClusterConfiguration"> <summary> <para type="description"> The updated Cohesity Cluster Configuration. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Cluster.SetCohesityClusterConfiguration.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Cluster.SetCohesityClusterConfiguration.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Alert.GetCohesityAlertResolution"> <summary> <para type="synopsis"> Returns all Alert Resolution objects found on the Cohesity Cluster that match the filter criteria specified using parameters. </para> <para type="description"> If no filter parameters are specified, all Alert Resolution objects are returned. Each object provides details about the Alert Resolution such as the resolution summary and details. </para> </summary> <example> <para>PS></para> <code> Get-CohesityAlertResolution -MaxAlerts 10 </code> <para> Gets a list of most recent 10 alertResoulitions triggered on the Cohesity Cluster. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Alert.GetCohesityAlertResolution.MaxAlerts"> <summary> <para type="description"> Limit the number of alerts to the specified value. The newest alerts are returned upto the limit specified. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Alert.GetCohesityAlertResolution.ResolutionIds"> <summary> <para type="description"> Filter by a list of resolution Ids. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Alert.GetCohesityAlertResolution.AlertIds"> <summary> <para type="description"> Filter by a list of alert Ids. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Alert.GetCohesityAlertResolution.StartTime"> <summary> <para type="description"> Filter by start date and time by specifying a unix epoch time in microseconds. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Alert.GetCohesityAlertResolution.EndTime"> <summary> <para type="description"> Filter by end date and time by specifying a unix epoch time in microseconds. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Alert.GetCohesityAlertResolution.ProcessRecord"> <summary> Process Records </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.AuditLog.GetCohesityAuditLog"> <summary> <para type="synopsis"> Gets a list of audit logs generated on the Cohesity Cluster. </para> <para type="description"> If no parameters are specified, all audit logs currently on the Cohesity Cluster are returned. </para> </summary> <example> <para>PS></para> <code> Get-CohesityAuditLog -UserNames admin </code> <para> All audit logs related to the username admin are displayed. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.AuditLog.GetCohesityAuditLog.UserNames"> <summary> <para type="description"> Filter by user names who caused the actions that generate Cluster Audit Logs. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.AuditLog.GetCohesityAuditLog.Domains"> <summary> <para type="description"> Filter by domains of users who caused the actions that trigger Cluster audit logs. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.AuditLog.GetCohesityAuditLog.EntityTypes"> <summary> <para type="description"> Filter by entity types involved in the actions that generate the Cluster audit logs, such as User, Protection Job, View, etc. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.AuditLog.GetCohesityAuditLog.Actions"> <summary> <para type="description"> Filter by the actions that generate Cluster audit logs such as Activate, Cancel, Clone, Create, etc. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.AuditLog.GetCohesityAuditLog.StartTime"> <summary> <para type="description"> Filter by start date and time by specifying a unix epoch time in microseconds. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.AuditLog.GetCohesityAuditLog.EndTime"> <summary> <para type="description"> Filter by end date and time by specifying a unix epoch time in microseconds. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.AuditLog.GetCohesityAuditLog.Search"> <summary> <para type="description"> Filter by matching a substring in entity name or details of the Cluster audit logs. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.AuditLog.GetCohesityAuditLog.StartIndex"> <summary> <para type="description"> Specifies an index number that can be used to return subsets of items in multiple requests. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.AuditLog.GetCohesityAuditLog.PageCount"> <summary> <para type="description"> Limit the number of items to return in the response for pagination purposes. Default value is 1000. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.AuditLog.GetCohesityAuditLog.ProcessRecord"> <summary> Process Records </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Clone.CopyCohesityVMwareVM"> <summary> <para type="synopsis"> Clones the specified VMware virtual machine. </para> <para type="description"> Clones the specified VMware virtual machine. </para> </summary> <example> <para>PS></para> <code> Copy-CohesityVMwareVM -TaskName "test-clone-task" -SourceId 883 -TargetViewName "test-vm-datastore" -JobId 49402 -VmNamePrefix "clone-" -DisableNetwork -PoweredOn -ResourcePoolId 893 </code> <para> Clones the VMware virtual machine with the given source id using the latest run of job id 49402. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Clone.CopyCohesityVMwareVM.TaskName"> <summary> <para type="description"> Specifies the name of the clone task. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Clone.CopyCohesityVMwareVM.TargetViewName"> <summary> <para type="description"> Specifies the name of the View where the cloned VM is stored. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Clone.CopyCohesityVMwareVM.SourceId"> <summary> <para type="description"> Specifies the source id of the VM to be cloned. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Clone.CopyCohesityVMwareVM.JobId"> <summary> <para type="description"> Specifies the job id that backed up this VM and will be used for cloning. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Clone.CopyCohesityVMwareVM.JobRunId"> <summary> <para type="description"> Specifies the job run id that captured the snapshot for this VM. If not specified the latest run is used. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Clone.CopyCohesityVMwareVM.StartTime"> <summary> <para type="description"> Specifies the time when the Job Run starts capturing a snapshot. Specified as a Unix epoch Timestamp (in microseconds). This must be specified if job run id is specified. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Clone.CopyCohesityVMwareVM.VmNamePrefix"> <summary> <para type="description"> Specifies the prefix to add to the name of the cloned VM. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Clone.CopyCohesityVMwareVM.VmNameSuffix"> <summary> <para type="description"> Specifies the suffix to add to the name of the cloned VM. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Clone.CopyCohesityVMwareVM.DisableNetwork"> <summary> <para type="description"> Specifies whether the network should be left in disabled state. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Clone.CopyCohesityVMwareVM.PoweredOn"> <summary> <para type="description"> Specifies the power state of the cloned VM. By default, the VM is powered off. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Clone.CopyCohesityVMwareVM.DatastoreFolderId"> <summary> <para type="description"> Specifies the folder where the datastore should be created when the VM is being cloned. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Clone.CopyCohesityVMwareVM.NetworkId"> <summary> <para type="description"> Specify this field to override the preserved network configuration or to attach a new network configuration to the cloned VM. By default, original network configuration is preserved if the VM is cloned under the same parent source and the same resource pool. Original network configuration is detached if the VM is cloned under a different vCenter or a different resource pool. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Clone.CopyCohesityVMwareVM.ResourcePoolId"> <summary> <para type="description"> Specifies the resource pool where the VM should be cloned. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Clone.CopyCohesityVMwareVM.VmFolderId"> <summary> <para type="description"> Specifies the folder where the VM should be cloned. This is applicable only when the VM is being cloned to an alternate location. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Clone.CopyCohesityVMwareVM.NewParentId"> <summary> <para type="description"> Specifies a new parent source such as vCenter to clone the VM. If not specified, the VM is cloned to its original parent source. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Clone.CopyCohesityVMwareVM.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Clone.CopyCohesityVMwareVM.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Clone.RemoveCohesityClone"> <summary> <para type="synopsis"> Removes or tears down a Cohesity clone. </para> <para type="description"> Removes or tears down the Cohesity clone created by the specified task id. </para> </summary> <example> <para>PS></para> <code> Remove-CohesityClone -TaskId 1234 </code> <para> Tears down the clone previously created by task id 1234. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Clone.RemoveCohesityClone.TaskId"> <summary> <para type="description"> Specifies the task id that created the clone to be removed. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Clone.RemoveCohesityClone.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Clone.RemoveCohesityClone.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Privilege.GetCohesityPrivilege"> <summary> <para type="synopsis"> Gets all privileges defined on the Cohesity Cluster. </para> <para type="description"> In addition, information about each privilege is returned such as the associated category, description, name. </para> </summary> <example> <para>PS></para> <code> Get-CohesityPrivilege -Name PRINCIPAL_VIEW </code> <para> Gets details of privilege with name PRINCIPAL_VIEW. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Privilege.GetCohesityPrivilege.Name"> <summary> <para type="description"> Specifies the name of the Privilege. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Privilege.GetCohesityPrivilege.ProcessRecord"> <summary> Process Records </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionJobRun.RemoveCohesitySnapshot"> <summary> <para type="synopsis"> Removes the Cohesity snapshots associated with a Protection Job. </para> <para type="description"> Returns success if the snapshots associated with the specified Protection Job are expired successfully. </para> </summary> <example> <para>PS></para> <code> Remove-CohesitySnapshot -JobName Test-Job -JobRunId 2123 </code> <para> Expires the snapshots associated with the specified Protection Job and Job Run Id. </para> </example> <example> <para>PS></para> <code> Remove-CohesitySnapshot -JobName Test-Job -JobRunId 2123 -SourceIds 883 </code> <para> Expires the snapshots associated with only the specified Source Id (such as a VM), Protection Job and Job Run Id. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJobRun.RemoveCohesitySnapshot.JobObject"> <summary> <para type="description"> The piped job object. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJobRun.RemoveCohesitySnapshot.JobName"> <summary> <para type="description"> The name of the Protection Job. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJobRun.RemoveCohesitySnapshot.JobRunId"> <summary> <para type="description"> The unique id of the Protection Job Run. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJobRun.RemoveCohesitySnapshot.SourceIds"> <summary> <para type="description"> Specifies the source ids to only expire snapshots belonging to those source ids. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionJobRun.RemoveCohesitySnapshot.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionJobRun.RemoveCohesitySnapshot.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionJob.DisableCohesityProtectionJob"> <summary> <para type="synopsis"> Deactivates the specified protection job. </para> <para type="description"> Deactivates the specified protection job. This is used for failover to a remote cluster. </para> </summary> <example> <para>PS></para> <code> Disable-CohesityProtectionJob -Id 1234 </code> <para> Deactivates the protection job with the Id of 1234. </para> </example> <example> <para>PS></para> <code> Disable-CohesityProtectionJob -Name "vm-replication-job" -PowerOffVms </code> <para> Deactivates the protection job with the name "vm-replication-job" and also powers off the associated VMs in VMware environment. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.DisableCohesityProtectionJob.Id"> <summary> <para type="description"> Specifies the unique id of the protection job. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.DisableCohesityProtectionJob.Name"> <summary> <para type="description"> Specifies the name of the protection job. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.DisableCohesityProtectionJob.PowerOffVms"> <summary> <para type="description"> Specifies whether to power off the VMs in VMware environment. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionJob.DisableCohesityProtectionJob.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionJob.DisableCohesityProtectionJob.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionJob.EnableCohesityProtectionJob"> <summary> <para type="synopsis"> Activates the specified protection job. </para> <para type="description"> Activates the specified protection job. This is used for failback scenario on remote cluster. </para> </summary> <example> <para>PS></para> <code> Enable-CohesityProtectionJob -Id 1234 -PolicyId "437211583895198:1541716981258:3" -ParentSourceId 13 </code> <para> Activates a protection job with the id of 1234 and associates it with the specified policy id and source id. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.EnableCohesityProtectionJob.Id"> <summary> <para type="description"> Specifies the unique id of the protection job. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.EnableCohesityProtectionJob.Name"> <summary> <para type="description"> Specifies the name of the protection job. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionJob.EnableCohesityProtectionJob.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.EnableCohesityProtectionJob.PolicyId"> <summary> <para type="description"> Specifies the unique id of the protection policy to be associated with the protection job. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.EnableCohesityProtectionJob.ParentSourceId"> <summary> <para type="description"> Specifies the unique id of the parent protection source (eg. a vCenter server) protected by this protection job. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionJob.EnableCohesityProtectionJob.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionJob.NewCohesityProtectionJob"> <summary> <para type="synopsis"> Creates a new protection job. </para> <para type="description"> Returns the created protection job. </para> </summary> <example> <para>PS></para> <code> New-CohesityProtectionJob -Name 'Test-Job-View' -Description 'Protects a View' -PolicyId 4816026365909361:1530076822448:1 -Environment kView -ViewName cohesity_int_19417 -StorageDomainId 3144 </code> <para> Creates a protection job for protecting a Cohesity View. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.NewCohesityProtectionJob.Name"> <summary> <para type="description"> Specifies the name of the protection job. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.NewCohesityProtectionJob.Description"> <summary> <para type="description"> Specifies the description of the protection job. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.NewCohesityProtectionJob.PolicyId"> <summary> <para type="description"> Specifies the unique id of the protection policy associated with the protection job. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.NewCohesityProtectionJob.PolicyName"> <summary> <para type="description"> Specifies the name of the protection policy associated with the protection job. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.NewCohesityProtectionJob.ParentSourceId"> <summary> <para type="description"> Specifies the unique id of the parent protection source (such as a vCenter server) protected by this protection job. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.NewCohesityProtectionJob.SourceIds"> <summary> <para type="description"> Specifies the unique id of the protection source objects (such as a virtual machines) protected by this protection job. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.NewCohesityProtectionJob.ExcludeSourceIds"> <summary> <para type="description"> Specifies a list of Source ids from a Protection Source that should not be protected by this Protection Job. Both leaf and non-leaf Objects may be specified in this list. An Object in this list must have its ancestor in the SourceIds list. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.NewCohesityProtectionJob.VmTagIds"> <summary> <para type="description"> Specifies a list of VM tag ids to protect VMs with the corresponding tags. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.NewCohesityProtectionJob.ExcludeVmTagIds"> <summary> <para type="description"> Specifies a list of VM tag ids to exclude VMs with the corresponding tags. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.NewCohesityProtectionJob.Timezone"> <summary> <para type="description"> Specifies the timezone for this protection job. Must be a string in Olson time zone format such as "America/Los_Angeles". </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.NewCohesityProtectionJob.ScheduleStartTime"> <summary> <para type="description"> Specifies the start date time for this protection job. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.NewCohesityProtectionJob.StorageDomainId"> <summary> <para type="description"> Specifies the storage domain (view box) id where this job writes data. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.NewCohesityProtectionJob.StorageDomainName"> <summary> <para type="description"> Specifies the name of the storage domain associated with the protection job. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.NewCohesityProtectionJob.ViewName"> <summary> <para type="description"> Specifies the name of the View associated with the protection job. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.NewCohesityProtectionJob.FullSLATimeInMinutes"> <summary> <para type="description"> Specifies the number of minutes that a Job Run of a Full (no CBT) backup schedule is expected to complete within, also known as a Service-Level Agreement (SLA). A SLA violation is reported when the run time of a Job Run exceeds the SLA time period specified for this backup schedule. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.NewCohesityProtectionJob.IncrementalSLATimeInMinutes"> <summary> <para type="description"> Specifies the number of minutes that a Job Run of a CBT-based backup schedule is expected to complete within, also known as a Service-Level Agreement (SLA). A SLA violation is reported when the run time of a Job Run exceeds the SLA time period specified for this backup schedule. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.NewCohesityProtectionJob.Environment"> <summary> <para type="description"> Specifies the environment that this job is protecting. Default is kView. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.NewCohesityProtectionJob.SourceSpecialParameters"> <summary> <para type="description"> Specifies additional settings that can apply to a subset of the Sources listed in the Protection Job.For example, you can specify a list of files and folders to protect instead of protecting the entire Physical Server.If this field's setting conflicts with environmentParameters, then this setting will be used. Specific volume selections must be passed in here to take effect. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.NewCohesityProtectionJob.EnableIndexing"> <summary> <para type="description"> Specifies settings for indexing files found in an Object (such as a VM) so these files can be searched and recovered. This also specifies inclusion and exclusion rules that determine the directories to index (backup files). </para> </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionJob.RemoveCohesityProtectionJob"> <summary> <para type="synopsis"> Removes a protection job. </para> <para type="description"> Returns success if the protection job is deleted. </para> </summary> <example> <para>PS></para> <code> Remove-CohesityProtectionJob -Id 1234 </code> <para> Removes a protection job with the Id of 1234 and all snapshots generated by the protection job. </para> </example> <example> <para>PS></para> <code> Remove-CohesityProtectionJob -Id 1234 -KeepSnapshots </code> <para> Removes a protection job with the Id of 1234, snapshots generated by the protection job are not deleted. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.RemoveCohesityProtectionJob.Id"> <summary> <para type="description"> Specifies the unique id of the protection job. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.RemoveCohesityProtectionJob.Name"> <summary> <para type="description"> Specifies the name of the protection job. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.RemoveCohesityProtectionJob.KeepSnapshots"> <summary> <para type="description"> Specifies if snapshots generated by the protection job should be kept intact when the job is deleted. If not specified, the snapshots are also deleted when the protection job is deleted. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionJob.RemoveCohesityProtectionJob.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionJob.RemoveCohesityProtectionJob.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionJob.ResumeCohesityProtectionJob"> <summary> <para type="synopsis"> Resumes the future runs of the specified protection job. </para> <para type="description"> This operation restores the protection job to a running state and new runs are started as defined by the schedule in the policy associated with the job. Returns success if the state is changed. </para> </summary> <example> <para>PS></para> <code> Resume-CohesityProtectionJob -Id 1234 </code> <para> Resumes a protection job with the Id of 1234. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.ResumeCohesityProtectionJob.Id"> <summary> <para type="description"> Specifies the unique id of the protection job. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.ResumeCohesityProtectionJob.Name"> <summary> <para type="description"> Specifies the name of the protection job. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionJob.ResumeCohesityProtectionJob.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionJob.ResumeCohesityProtectionJob.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionJob.StartCohesityProtectionJob"> <summary> <para type="synopsis"> Immediately starts a protection job run. </para> <para type="description"> Immediately starts a protection job run. A protection policy associated with the job may define various backup run types: Regular (Incremental, CBT utilized), Full (CBT not utilized), Log, System. The passed in run type defines what type of backup is performed by the job run. The schedule defined in the policy for the backup run type is ignored but other settings such as the snapshot retention and retry settings are used. Returns success if the job run starts. </para> </summary> <example> <para>PS></para> <code> Start-CohesityProtectionJob -Id 1234 </code> <para> Immediately starts a job run for the given protection job. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.StartCohesityProtectionJob.Id"> <summary> <para type="description"> Specifies a unique id of the protection job. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.StartCohesityProtectionJob.Name"> <summary> <para type="description"> Specifies the name of the protection job. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.StartCohesityProtectionJob.RunType"> <summary> <para type="description"> Specifies the type of backup. If not specified, "KRegular" is assumed. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.StartCohesityProtectionJob.SourceIds"> <summary> <para type="description"> If you want to back up only a subset of sources that are protected by the job in this run. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.StartCohesityProtectionJob.CopyRunTargets"> <summary> <para type="description"> Set if you want specific replication or archival associated with the policy to run. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionJob.StartCohesityProtectionJob.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionJob.StartCohesityProtectionJob.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionJob.SuspendCohesityProtectionJob"> <summary> <para type="synopsis"> Pauses the future runs of the specified protection job. </para> <para type="description"> If the protection job is currently running this operation stops any future runs of this protection job from starting and executing. However, any existing runs that were already in progress will continue to run. Returns success if the paused state is changed. </para> </summary> <example> <para>PS></para> <code> Suspend-CohesityProtectionJob -Id 1234 </code> <para> Pauses a protection job with the Id of 1234. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.SuspendCohesityProtectionJob.Id"> <summary> <para type="description"> Specifies the unique id of the protection job. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionJob.SuspendCohesityProtectionJob.Name"> <summary> <para type="description"> Specifies the name of the protection job. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionJob.SuspendCohesityProtectionJob.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionJob.SuspendCohesityProtectionJob.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionPolicy.RemoveCohesityProtectionPolicy"> <summary> <para type="synopsis"> Removes a protection policy. </para> <para type="description"> Returns success if the protection policy is removed. </para> </summary> <example> <para>PS></para> <code> Remove-CohesityProtectionPolicy -Id 7004504288922732:1533243443420:3 </code> <para> Removes a protection policy with the specified Id. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionPolicy.RemoveCohesityProtectionPolicy.Id"> <summary> <para type="description"> Specifies the unique id of the protection policy. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionPolicy.RemoveCohesityProtectionPolicy.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionPolicy.RemoveCohesityProtectionPolicy.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionSource.GetCohesityMSSQLObject"> <summary> <para type="synopsis"> Gets a list of the MS SQL objects known to the Cohesity Cluster. </para> <para type="description"> Returns all the MS SQL objects (databases, instances) known to the Cohesity Cluster. </para> </summary> <example> <para>PS></para> <code> Get-CohesityMSSQLObject </code> <para> Gets a list of the MS SQL objects known to the Cohesity Cluster. </para> </example> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionSource.GetCohesityMSSQLObject.BeginProcessing"> <summary> Begin Processing </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionSource.GetCohesityMSSQLObject.ProcessRecord"> <summary> Process Record </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionSource.GetCohesityVMwareVM"> <summary> <para type="synopsis"> Gets a list of the VMware virtual machines known to the Cohesity Cluster. </para> <para type="description"> Returns all the VMware virtual machines known to the Cohesity Cluster that match the filter criteria specified using parameters. If the ParentSourceId is specified, only VMs found in that parent source (such as a vCenter Server) are returned. </para> </summary> <example> <para>PS></para> <code> Get-CohesityVMwareVM -ParentSourceId 2 </code> <para> Gets a list of the virtual machines belonging to the vCenter Server with the ParentSourceId of 2. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.GetCohesityVMwareVM.ParentSourceId"> <summary> <para type="description"> Limit the VMs returned to the set of VMs found in a specific parent source (such as vCenter Server). </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.GetCohesityVMwareVM.Names"> <summary> <para type="description"> Limit the returned VMs to those that exactly match the passed in VM name. To match multiple VM names, specify multiple names separated by commas. The string must exactly match the passed in VM name and wild cards are not supported. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.GetCohesityVMwareVM.Uuids"> <summary> <para type="description"> Limit the returned VMs to those that exactly match the passed in Uuids. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.GetCohesityVMwareVM.Protected"> <summary> <para type="description"> Limit the returned VMs to those that have been protected by a protection job. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.GetCohesityVMwareVM.Unprotected"> <summary> <para type="description"> Limit the returned VMs to those that are not protected by any protection job. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionSource.GetCohesityVMwareVM.BeginProcessing"> <summary> Begin Processing </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionSource.GetCohesityVMwareVM.ProcessRecord"> <summary> Process Record </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceAcropolis"> <summary> <para type="synopsis"> Registers a new Nutanix Acropolis protection source with the Cohesity Cluster. </para> <para type="description"> Registers a new Nutanix Acropolis protection source with the Cohesity Cluster. </para> </summary> <example> <para>PS></para> <code> Register-CohesityProtectionSourceAcropolis -Server nutanix-ahv.example.com -Credential (Get-Credential) </code> <para> Registers a new Nutanix Acropolis cluster with hostname "nutanix-ahv.example.com" with the Cohesity Cluster. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceAcropolis.Server"> <summary> <para type="description"> Hostname or IP Address for the Acropolis cluster. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceAcropolis.Credential"> <summary> <para type="description"> User credentials for the Acropolis cluster. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceAcropolis.EntityType"> <summary> <para type="description"> Specifies entity type for acropolis. Recommend to use the default value 'KStandaloneCluster'. </para> </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceMSSQL"> <summary> <para type="synopsis"> Registers an existing source as running MS SQL application. </para> <para type="description"> Registers an existing source as running MS SQL application. </para> </summary> <example> <para>PS></para> <code> Register-CohesityProtectionSourceMSSQL -Id $sourceId -HasPersistentAgent </code> <para> Registers the specified source as running MS SQL application and uses the installed agent to connect. </para> </example> <example> <para>PS></para> <code> Register-CohesityProtectionSourceMSSQL -Id $sourceId -Credential (Get-Credential) </code> <para> Registers the specified source as running MS SQL application and connects using provided credentials. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceMSSQL.Id"> <summary> <para type="description"> Specifies the Id of the Protection Source that has MS SQL Application Server running on it. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceMSSQL.HasPersistentAgent"> <summary> <para type="description"> Specifies if a persistent agent is running on the host. If this is specified, then credentials are not used. This mechanism may be used in environments such as VMware to get around UAC permission issues by running the agent as a service with the right credentials. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceMSSQL.Credential"> <summary> <para type="description"> User credentials used to connect to the host. </para> </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceNetApp"> <summary> <para type="synopsis"> Registers a new NetApp protection source with the Cohesity Cluster. </para> <para type="description"> Registers a new NetApp protection source with the Cohesity Cluster. </para> </summary> <example> <para>PS></para> <code> Register-CohesityProtectionSourceNetApp -Server netapp-cluster.example.com -Type KCluster -Credential (Get-Credential) </code> <para> Registers a new NetApp cluster with hostname "netapp-cluster.example.com" with the Cohesity Cluster. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceNetApp.Server"> <summary> <para type="description"> Hostname or IP Address for the NetApp cluster or Vserver. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceNetApp.Credential"> <summary> <para type="description"> User credentials for the NetApp cluster or Vserver. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceNetApp.Type"> <summary> <para type="description"> Type of NetApp server. Must be set to KCluster or KVserver. </para> </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceNFS"> <summary> <para type="synopsis"> Registers a new NFS mount point as protection source with the Cohesity Cluster. </para> <para type="description"> Registers a new NFS mount point as protection source with the Cohesity Cluster. </para> </summary> <example> <para>PS></para> <code> Register-CohesityProtectionSourceNFS -MountPath "file-server.example.com:/sourcevol" </code> <para> Registers a new NFS mount point with mount path "file-server.example.com:/sourcevol" with the Cohesity Cluster. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceNFS.MountPath"> <summary> <para type="description"> NFS Mount path. </para> </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourcePhysical"> <summary> <para type="synopsis"> Registers a new Physical protection source with the Cohesity Cluster. </para> <para type="description"> Registers a new Physical protection source with the Cohesity Cluster. </para> </summary> <example> <para>PS></para> <code> Register-CohesityProtectionSourcePhysical -Server server.example.com -HostType KLinux -PhysicalType KHost </code> <para> Registers a physical linux server with hostname "server.example.com" with the Cohesity Cluster. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourcePhysical.Server"> <summary> <para type="description"> Hostname or IP Address of the Physical server. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourcePhysical.HostType"> <summary> <para type="description"> Type of host. Must be set to KLinux or KWindows. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourcePhysical.PhysicalType"> <summary> <para type="description"> Type of physical host. Must be set to KHost or KWindowsCluster. </para> </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourcePureStorageArray"> <summary> <para type="synopsis"> Registers a new Pure Storage array as a protection source. </para> <para type="description"> Registers a new Pure Storage array as a protection source with the Cohesity Cluster. </para> </summary> <example> <para>PS></para> <code> Register-CohesityProtectionSourcePureStorageArray -Server pure.example.com -Credential (Get-Credential) </code> <para> Registers a new Pure Storage array with hostname "pure.example.com" with the Cohesity Cluster. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourcePureStorageArray.Server"> <summary> <para type="description"> Hostname or IP Address for the Pure Storage array. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourcePureStorageArray.Credential"> <summary> <para type="description"> User credentials for the Pure Storage array. </para> </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceSMB"> <summary> <para type="synopsis"> Registers a new SMB file share as protection source with the Cohesity Cluster. </para> <para type="description"> Registers a new SMB file share as protection source with the Cohesity Cluster. </para> </summary> <example> <para>PS></para> <code> Register-CohesityProtectionSourceSMB -MountPath "\\smb-server.example.com\share -Credential (Get-Credential)" </code> <para> Registers a new SMB file share with mount path "\\smb-server.example.com\share" with the Cohesity Cluster. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceSMB.MountPath"> <summary> <para type="description"> NFS Mount path. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceSMB.Credential"> <summary> <para type="description"> User credentials for accessing the SMB file share. </para> </summary> </member> <member name="F:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceSMB.SkipValidation"> <summary> <para type="description"> Skip SMB validation registration </para> </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceVMware"> <summary> <para type="synopsis"> Registers a new VMware protection source. </para> <para type="description"> Registers a new VMware protection source with the Cohesity Cluster. </para> </summary> <example> <para>PS></para> <code> Register-CohesityProtectionSourceVMware -Server vcenter.example.com -Type KVcenter -Credential (Get-Credential) </code> <para> Registers a new vCenter server with hostname "vcenter.example.com" with the Cohesity Cluster. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceVMware.Server"> <summary> <para type="description"> Hostname or IP Address for the vCenter server or ESXi server. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceVMware.Type"> <summary> <para type="description"> Type of VMware server. Must be set to KStandaloneHost or KVcenter. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.RegisterCohesityProtectionSourceVMware.Credential"> <summary> <para type="description"> User credentials for the vCenter server or ESXi host. </para> </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionSource.UnregisterCohesityApplicationServer"> <summary> <para type="synopsis"> Unregisters the application server (such as SQL) running on the specified protection source from the Cohesity Cluster. </para> <para type="description"> Unregisters the application server (such as SQL) running on the specified protection source from the Cohesity Cluster. </para> </summary> <example> <para>PS></para> <code> Unregister-CohesityApplicationServer -Id 12 </code> <para> Unregisters the application server running on the protection source with Id 12 from Cohesity Cluster. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.UnregisterCohesityApplicationServer.Id"> <summary> <para type="description"> Specifies a unique id of the protection source. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.UnregisterCohesityApplicationServer.ProtectionSource"> <summary> <para type="description"> Specifies a protection source object. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionSource.UnregisterCohesityApplicationServer.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionSource.UnregisterCohesityApplicationServer.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionSource.UnregisterCohesityProtectionSource"> <summary> <para type="synopsis"> Unregisters the specified protection source from the Cohesity Cluster. </para> <para type="description"> Unregisters the specified protection source from the Cohesity Cluster. </para> </summary> <example> <para>PS></para> <code> Unregister-CohesityProtectionSource -Id 12 </code> <para> Unregisters the given protection source. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.UnregisterCohesityProtectionSource.Id"> <summary> <para type="description"> Specifies a unique id of the protection source. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.UnregisterCohesityProtectionSource.ProtectionSource"> <summary> <para type="description"> Specifies a protection source object. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionSource.UnregisterCohesityProtectionSource.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionSource.UnregisterCohesityProtectionSource.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.ProtectionSource.UpdateCohesityProtectionSource"> <summary> <para type="synopsis"> Refreshes the object hierarchy of the specified protection source on the Cohesity Cluster. </para> <para type="description"> Forces an immediate refresh of the specified protection source on the Cohesity Cluster. Returns success if the forced refresh has been started. Note that the amount of time to complete a refresh depends on the size of the object hierarchy. </para> </summary> <example> <para>PS></para> <code> Update-CohesityProtectionSource -Id 12 </code> <para> Immediately refreshes the given protection source. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.UpdateCohesityProtectionSource.Id"> <summary> <para type="description"> Specifies a unique id of the protection source. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.ProtectionSource.UpdateCohesityProtectionSource.ProtectionSource"> <summary> <para type="description"> Specifies a protection source object. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionSource.UpdateCohesityProtectionSource.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.ProtectionSource.UpdateCohesityProtectionSource.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Recovery.DismountCohesityVolume"> <summary> <para type="synopsis"> Removes or tears down Cohesity instant mount volumes. </para> <para type="description"> Removes or tears down the Cohesity instant mount volumes created by the specified task id. </para> </summary> <example> <para>PS></para> <code> Dismount-CohesityVolume -TaskId 1234 </code> <para> Tears down the Cohesity instant mount volumes created by task id 1234. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.DismountCohesityVolume.TaskId"> <summary> <para type="description"> Specifies the task id that created the instant mount volumes to be removed. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Recovery.DismountCohesityVolume.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Recovery.DismountCohesityVolume.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Recovery.FindCohesityFilesForRestore"> <summary> <para type="synopsis"> Finds a list of files and folders for restore based on the specified parameters. </para> <para type="description"> If no search pattern or filter parameters are specified, all files and folders currently found on the Cohesity Cluster are returned. </para> </summary> <example> <para>PS></para> <code> Find-CohesityFilesForRestore -Search "*txt" </code> <para> Returns only the files and folders that match the search pattern "txt". </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.FindCohesityFilesForRestore.Environments"> <summary> <para type="description"> Filter by environment types such as kVMware, kView, kSQL, etc. Only jobs protecting the specified environment types are returned. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.FindCohesityFilesForRestore.FolderOnly"> <summary> <para type="description"> Filter by folders or files. If true, only folders are returned. If false, only files are returned. If not specified, both files and folders are returned. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.FindCohesityFilesForRestore.Search"> <summary> <para type="description"> Filter by searching for sub-strings in the item name. The specified string can match any part of the name. For example: “vm” or “123” both match the name of "vm-123". </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.FindCohesityFilesForRestore.StartTime"> <summary> <para type="description"> Filter by backup completion time by specifying a backup completion start and end times. Specified as a Unix epoch Timestamp (in microseconds). Only items created by backups that completed between the specified start and end times are returned. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.FindCohesityFilesForRestore.EndTime"> <summary> <para type="description"> Filter by backup completion time by specify a backup completion start and end times. Specified as a Unix epoch Timestamp (in microseconds). Only items created by backups that completed between the specified start and end times are returned. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.FindCohesityFilesForRestore.JobIds"> <summary> <para type="description"> Filter by a list of protection job ids.Only items backed up by the specified jobs are listed. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.FindCohesityFilesForRestore.SourceIds"> <summary> <para type="description"> Filter by source ids. Only files and folders found in the listed sources (such as VMs) are returned. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.FindCohesityFilesForRestore.RegisteredSourceIds"> <summary> <para type="description"> Filter by a list of registered source ids. Only items from the listed registered sources are returned. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.FindCohesityFilesForRestore.StorageDomainIds"> <summary> <para type="description"> Filter by a list of storage domain (view box) ids. Only items stored in the listed domains (view boxes) are returned. </para> </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Recovery.FindCohesityObjectsForRestore"> <summary> <para type="synopsis"> Finds a list of objects (VMs and Databases) for restore based on the specified parameters. </para> <para type="description"> If no search pattern or filter parameters are specified, all objects currently found on the Cohesity Cluster are returned. </para> </summary> <example> <para>PS></para> <code> Find-CohesityObjectsForRestore -Search "linux" </code> <para> Returns only the objects that match the search pattern "linux". </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.FindCohesityObjectsForRestore.Environments"> <summary> <para type="description"> Filter by environment types such as kVMware, kView, kSQL, etc. Only jobs protecting the specified environment types are returned. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.FindCohesityObjectsForRestore.Search"> <summary> <para type="description"> Filter by searching for sub-strings in the object name. The specified string can match any part of the name. For example: “vm” or “123” both match the name of "vm-123". </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.FindCohesityObjectsForRestore.StartTime"> <summary> <para type="description"> Filter by backup completion time by specifying a backup completion start and end times. Specified as a Unix epoch Timestamp (in microseconds). Only items created by backups that completed between the specified start and end times are returned. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.FindCohesityObjectsForRestore.EndTime"> <summary> <para type="description"> Filter by backup completion time by specify a backup completion start and end times. Specified as a Unix epoch Timestamp (in microseconds). Only items created by backups that completed between the specified start and end times are returned. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.FindCohesityObjectsForRestore.JobIds"> <summary> <para type="description"> Filter by a list of protection job ids. Only objects backed up by the specified jobs are listed. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.FindCohesityObjectsForRestore.RegisteredSourceIds"> <summary> <para type="description"> Filter by a list of registered source ids. Only objects from the listed registered sources are returned. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.FindCohesityObjectsForRestore.StorageDomainIds"> <summary> <para type="description"> Filter by a list of storage domain (view box) ids. Only objects stored in the listed domains (view boxes) are returned. </para> </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Recovery.GetCohesityRestoreTask"> <summary> <para type="synopsis"> Gets a list of the restore tasks filtered by the specified parameters. </para> <para type="description"> If no parameters are specified, all the restore tasks on the Cohesity Cluster are returned. </para> </summary> <example> <para>PS></para> <code> Get-CohesityRestoreTask -Types kRecoverVMs </code> <para> Returns only the restore tasks that match the type 'kRecoverVMs'. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.GetCohesityRestoreTask.Ids"> <summary> <para type="description"> Filter by a list of task ids. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.GetCohesityRestoreTask.Types"> <summary> <para type="description"> Filter by a list of task types, such as 'kRecoverVMs’, 'kCloneVMs’, ‘kCloneView’ or 'kMountVolumes’. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.GetCohesityRestoreTask.StartTime"> <summary> <para type="description"> Filter by start date and time by specifying a unix epoch time in microseconds. All Restore Tasks (both completed and running) on the Cohesity Cluster that started after the specified start time but before the specified end time are returned. If not set, the start time is creation time of the Cohesity Cluster. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.GetCohesityRestoreTask.EndTime"> <summary> <para type="description"> Filter by end date and time by specifying a unix epoch time in microseconds. All Restore Tasks (both completed and running) on the Cohesity Cluster that started after the specified start time but before the specified end time are returned. If not set, the end time is the current time. </para> </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Recovery.MountCohesityVolume"> <summary> <para type="synopsis"> Mounts the specified volumes instantly to a target host from a previous backup. </para> <para type="description"> Mounts the specified volumes instantly to a target host from a previous backup. </para> </summary> <example> <para>PS></para> <code> Mount-CohesityVolume -TaskName "Test-Mount" -SourceId 12 -JobId 8 -BringDisksOnline -TargetHostId 23 -TargetHostCredential (Get-Credential) </code> <para> Mounts the volumes corresponding to the given source id to the given target host id using the latest run of job id 8. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.MountCohesityVolume.TaskName"> <summary> <para type="description"> Specifies the name of the instant volume mount task. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.MountCohesityVolume.SourceId"> <summary> <para type="description"> Specifies the source id that was backed up. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.MountCohesityVolume.JobId"> <summary> <para type="description"> Specifies the job id to be used for this instant volume mount. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.MountCohesityVolume.JobRunId"> <summary> <para type="description"> Specifies the job run id to be used for this instant volume mount. If not specified the latest run is used. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.MountCohesityVolume.StartTime"> <summary> <para type="description"> Specifies the time when the Job Run starts capturing a snapshot. Specified as a Unix epoch Timestamp (in microseconds). This must be specified if job run id is specified. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.MountCohesityVolume.BringDisksOnline"> <summary> <para type="description"> Specifies if the volumes will be brought online on the mount target after attaching the disks. This field is only applicable for VMs. The Cohesity Cluster always attempts to mount Physical servers. If the mount target is a VM, then VMware Tools must be installed on the guest operating system and login credentials to the mount target must be specified. NOTE: If automount is configured for a Windows system, the volumes may be automatically brought online. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.MountCohesityVolume.NewParentId"> <summary> <para type="description"> Specifies a new registered parent Protection Source. If not specified, the original parent source will be used. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.MountCohesityVolume.TargetHostId"> <summary> <para type="description"> Specifies the source id of the target host where the volumes will be mounted. NOTE: The source that was backed up and the mount target must be the same type, for example if the source is a VMware VM, then the mount target must also be a VMware VM. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.MountCohesityVolume.TargetHostCredential"> <summary> <para type="description"> User credentials for accessing the target host for mounting the volumes. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.MountCohesityVolume.VolumeNames"> <summary> <para type="description"> Specifies the names of volumes to mount. If none are specified, all volumes are mounted on the target. Note: Windows volumes should be specified in unix format. '/C' instead of 'C:' </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Recovery.MountCohesityVolume.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Recovery.MountCohesityVolume.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityAcropolisVM"> <summary> <para type="synopsis"> Restores the specified Nutanix Acropolis virtual machine from a previous backup. </para> <para type="description"> Restores the specified Nutanix Acropolis virtual machine from a previous backup. </para> </summary> <example> <para>PS></para> <code> Restore-CohesityAcropolisVM -TaskName "Test-Restore" -SourceId 2 -JobId 8 -VmNamePrefix "copy-" -DisableNetwork -PoweredOn </code> <para> Restores the Nutanix Acropolis virtual machine with the given source id using the latest run of job id 8. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityAcropolisVM.TaskName"> <summary> <para type="description"> Specifies the name of the restore task. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityAcropolisVM.SourceId"> <summary> <para type="description"> Specifies the source id of the VM to be restored. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityAcropolisVM.JobId"> <summary> <para type="description"> Specifies the job id that backed up this VM and will be used for this restore. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityAcropolisVM.JobRunId"> <summary> <para type="description"> Specifies the job run id that captured the snapshot for this VM. If not specified the latest run is used. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityAcropolisVM.StartTime"> <summary> <para type="description"> Specifies the time when the Job Run starts capturing a snapshot. Specified as a Unix epoch Timestamp (in microseconds). This must be specified if job run id is specified. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityAcropolisVM.VmNamePrefix"> <summary> <para type="description"> Specifies the prefix to add to the name of the restored VM. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityAcropolisVM.VmNameSuffix"> <summary> <para type="description"> Specifies the suffix to add to the name of the restored VM. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityAcropolisVM.DisableNetwork"> <summary> <para type="description"> Specifies whether the network should be left in disabled state. Attached network is enabled by default. Use this switch to disable it. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityAcropolisVM.PoweredOn"> <summary> <para type="description"> Specifies the power state of the recovered VM. By default, the VM is powered off. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityAcropolisVM.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityAcropolisVM.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityFile"> <summary> <para type="synopsis"> Restores the specified files or folders from a previous backup. </para> <para type="description"> Restores the specified files or folders from a previous backup. </para> </summary> <example> <para>PS></para> <code> Restore-CohesityFile -TaskName "restore-file-vm" -FileNames /C/data/file.txt -JobId 1234 -SourceId 843 -TargetSourceId 856 -TargetParentSourceId 828 -TargetHostType KWindows -TargetHostCredential (Get-Credential) </code> <para> Restores the specified file to the target windows VM with the source id 856 from the latest backup. </para> </example> <example> <para>PS></para> <code> Restore-CohesityFile -TaskName "restore-file-physical" -FileNames /C/data/file.txt -JobId 1234 -SourceId 820 -TargetSourceId 858 </code> <para> Restores the specified file to the target physical server with the source id 858 from the latest backup. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityFile.TaskName"> <summary> <para type="description"> Specifies the name of the Restore Task. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityFile.FileNames"> <summary> <para type="description"> Specifies the full names of the files or folders to be restored. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityFile.JobId"> <summary> <para type="description"> Specifies the job id that backed up the files and will be used for this restore. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityFile.SourceId"> <summary> <para type="description"> Specifies the id of the original protection source (that was backed up) containing the files and folders. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityFile.NewBaseDirectory"> <summary> <para type="description"> Specifies an optional base directory where the specified files and folders will be restored. By default, files and folders are restored to their original path. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityFile.JobRunId"> <summary> <para type="description"> Specifies the Job Run id that captured the snapshot. If not specified, the latest backup run is used. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityFile.StartTime"> <summary> <para type="description"> Specifies the time when the Job Run started capturing a snapshot. Specified as a Unix epoch Timestamp (in microseconds). This must be specified if the job run id is specified. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityFile.DoNotOverwrite"> <summary> <para type="description"> Specifies that any existing files and folders should not be overwritten during the restore. By default, any existing files and folders are overwritten by restored files and folders. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityFile.ContinueOnError"> <summary> <para type="description"> Specifies if the Restore Task should continue even if the restore of some files and folders fails. If specified, the Restore Task ignores errors and restores as many files and folders as possible. By default, the Restore Task stops restoring if any operation fails. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityFile.DoNotPreserveAttributes"> <summary> <para type="description"> Specifies that the Restore Task should not preserve the original attributes of the files and folders. By default, the original attributes are preserved. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityFile.TargetSourceId"> <summary> <para type="description"> Specifies the id of the target source (such as a VM or Physical server) where the files and folders are to be restored. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityFile.TargetParentSourceId"> <summary> <para type="description"> Specifies the id of the registered parent source (such as a vCenter Server) that contains the target source (such as a VM). This is not required when restoring to a Physical Server but must be specified when restoring to a VM. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityFile.TargetHostType"> <summary> <para type="description"> Specifies the operating system type of the target host. This is not required when restoring to a Physical Server but must be specified when restoring to a VM. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityFile.TargetHostCredential"> <summary> <para type="description"> User credentials for accessing the target host for restore. This is not required when restoring to a Physical Server but must be specified when restoring to a VM. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityFile.FileRecoveryMethod"> <summary> <para type="description"> Specifies the type of method to be used to perform file recovery. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityFile.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityFile.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityHyperVVM"> <summary> <para type="synopsis"> Restores the specified Hyper-V virtual machine from a previous backup. </para> <para type="description"> Restores the specified Hyper-V virtual machine from a previous backup. </para> </summary> <example> <para>PS></para> <code> Restore-CohesityHyperVVM -TaskName "Test-Restore" -SourceId 2 -JobId 8 -VmNamePrefix "copy-" -DisableNetwork -PoweredOn </code> <para> Restores the Hyper-V virtual machine with the given source id using the latest run of job id 8. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityHyperVVM.TaskName"> <summary> <para type="description"> Specifies the name of the restore task. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityHyperVVM.SourceId"> <summary> <para type="description"> Specifies the source id of the VM to be restored. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityHyperVVM.JobId"> <summary> <para type="description"> Specifies the job id that backed up this VM and will be used for this restore. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityHyperVVM.JobRunId"> <summary> <para type="description"> Specifies the job run id that captured the snapshot for this VM. If not specified the latest run is used. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityHyperVVM.StartTime"> <summary> <para type="description"> Specifies the time when the Job Run starts capturing a snapshot. Specified as a Unix epoch Timestamp (in microseconds). This must be specified if job run id is specified. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityHyperVVM.VmNamePrefix"> <summary> <para type="description"> Specifies the prefix to add to the name of the restored VM. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityHyperVVM.VmNameSuffix"> <summary> <para type="description"> Specifies the suffix to add to the name of the restored VM. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityHyperVVM.DisableNetwork"> <summary> <para type="description"> Specifies whether the network should be left in disabled state. Attached network is enabled by default. Use this switch to disable it. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityHyperVVM.PoweredOn"> <summary> <para type="description"> Specifies the power state of the recovered VM. By default, the VM is powered off. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityHyperVVM.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityHyperVVM.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityMSSQLObject"> <summary> <para type="synopsis"> Restores the specified MS SQL object from a previous backup. </para> <para type="description"> Restores the specified MS SQL object from a previous backup. </para> </summary> <example> <para>PS></para> <code> Restore-CohesityMSSQLObject -TaskName "sql-restore-task" -SourceId 9 -HostSourceId 3 -JobId 401 </code> <para> Restores the MS SQL DB with the given source id using the latest run of job id 401. </para> </example> <example> <para>PS></para> <code> $patternList = @() $pattern = [Cohesity.Model.FilenamePatternToDirectory]::new() $pattern.Directory = "C:\Secondary" $pattern.FilenamePattern = "*.mdf" $patternList += $pattern Restore-CohesityMSSQLObject -TaskName "restore-sql" -SourceId 698 -HostSourceId 675 -JobId 1359 ` -NewDatabaseName "restore-1" -NewInstanceName MSSQLSERVER -TargetHostId 972 ` -TargetDataFilesDirectory "C:\TEST Data" -TargetLogFilesDirectory "C:\TEST Log" ` -TargetSecondaryDataFilesDirectoryList $patternList </code> <para> Restores the MS SQL DB with the given source id on a target server. </para> </example> <example> <para>PS></para> <code> Restore-CohesityMSSQLObject -TaskName "restore-sql" -SourceId 3101 -HostSourceId 3099 -JobId 51275 ` -TargetHostId 3098 -CaptureTailLogs:$false -NewDatabaseName ReportServer_r26 ` -NewInstanceName MSSQLSERVER -TargetDataFilesDirectory "C:\temp" -TargetLogFilesDirectory "C:\temp" ` -StartTime 1614450600000000 -RestoreTimeSecs 1617097060 </code> <para> Request for restore MSSQL object with RestoreTimeSecs (point in time) parameter and StartTime. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityMSSQLObject.TaskName"> <summary> <para type="description"> Specifies the name of the restore task. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityMSSQLObject.SourceId"> <summary> <para type="description"> Specifies the source id of the MS SQL database to restore. This can be obtained using Get-CohesityMSSQLObject. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityMSSQLObject.HostSourceId"> <summary> <para type="description"> Specifies the source id of the physical server or virtual machine that is hosting the MS SQL instance. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityMSSQLObject.JobId"> <summary> <para type="description"> Specifies the job id that backed up this MS SQL instance and will be used for this restore. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityMSSQLObject.JobRunId"> <summary> <para type="description"> Specifies the job run id that captured the snapshot for this MS SQL instance. If not specified the latest run is used. This field must be set if restoring to a different target host. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityMSSQLObject.StartTime"> <summary> <para type="description"> Specifies the time when the Job Run starts capturing a snapshot. Specified as a Unix epoch Timestamp (in microseconds). This must be specified if job run id is specified. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityMSSQLObject.CaptureTailLogs"> <summary> <para type="description"> Specifies if the tail logs are to be captured before the restore operation. This is only applicable if restoring the SQL database to its hosting Protection Source and the database is not being renamed. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityMSSQLObject.KeepOffline"> <summary> <para type="description"> Specifies if we want to restore the database and do not want to bring it online after restore. This is only applicable if restoring the database back to its original location. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityMSSQLObject.KeepCDC"> <summary> <para type="description"> This field prevents "change data capture" settings from being reomved. When a database or log backup is restored on another server and database is recovered. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityMSSQLObject.NewDatabaseName"> <summary> <para type="description"> Specifies a new name for the restored database. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityMSSQLObject.NewInstanceName"> <summary> <para type="description"> Specifies the instance name of the SQL Server that should be restored. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityMSSQLObject.RestoreTimeSecs"> <summary> <para type="description"> Specifies the time in the past to which the SQL database needs to be restored. This allows for granular recovery of SQL databases. If not specified, the SQL database will be restored from the full/incremental snapshot. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityMSSQLObject.TargetDataFilesDirectory"> <summary> <para type="description"> Specifies the directory where to put the database data files. Missing directory will be automatically created. This field must be set if restoring to a different target host. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityMSSQLObject.TargetLogFilesDirectory"> <summary> <para type="description"> Specifies the directory where to put the database log files. Missing directory will be automatically created. This field must be set if restoring to a different target host. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityMSSQLObject.TargetSecondaryDataFilesDirectoryList"> <summary> <para type="description"> Specifies the secondary data filename pattern and corresponding directories of the DB. Secondary data files are optional and are user defined. The recommended file extension for secondary files is ".ndf". If this option is specified and the destination folders do not exist they will be automatically created. This field can be set only if restoring to a different target host. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityMSSQLObject.TargetHostId"> <summary> <para type="description"> Specifies the target host if the application is to be restored to a different host. If not specified, then the application is restored to the original host (physical or virtual) that hosted this application. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityMSSQLObject.TargetHostParentId"> <summary> <para type="description"> Specifies the id of the registered parent source (such as vCenter) of the target host. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityMSSQLObject.TargetHostCredential"> <summary> <para type="description"> User credentials for accessing the target host for restore. This is not required when restoring to a Physical Server but must be specified when restoring to a VM. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityMSSQLObject.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Recovery.RestoreCohesityMSSQLObject.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Recovery.StopCohesityRestoreTask"> <summary> <para type="synopsis"> Cancels a restore task. </para> <para type="description"> </para> </summary> <example> <para>PS></para> <code> Stop-CohesityRestoreTask -Id 78 </code> <para> Cancels a running restore task with Id 78. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Recovery.StopCohesityRestoreTask.Id"> <summary> <para type="description"> Specifies a unique id of the restore task. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Recovery.StopCohesityRestoreTask.BeginProcessing"> <summary> Begin Processing </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Recovery.StopCohesityRestoreTask.ProcessRecord"> <summary> Process Record </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.RemoteCluster.GetCohesityRemoteCluster"> <summary> <para type="synopsis"> Gets a list of the remote clusters registered with the Cohesity Cluster </para> <para type="description"> All remote clusters that are registered with the Cohesity Cluster are returned. </para> </summary> <example> <para>PS></para> <code> Get-CohesityRemoteCluster </code> <para> Returns all the registered remote clusters. </para> </example> </member> <member name="T:Cohesity.Powershell.Cmdlets.RemoteCluster.NewCohesityReplicationEncryptionKey"> <summary> <para type="synopsis"> Generates a new encryption key that can be used for encrypting replication data between this Cluster and a remote Cluster. </para> <para type="description"> Generates a new encryption key that can be used for encrypting replication data between this Cluster and a remote Cluster. </para> </summary> <example> <para>PS></para> <code> Get-CohesityReplicationEncryptionKey </code> <para> Gets a new encryption key that can be used for encrypting replication data between this Cluster and a remote Cluster. </para> </example> </member> <member name="T:Cohesity.Powershell.Cmdlets.RemoteCluster.RegisterCohesityRemoteCluster"> <summary> <para type="synopsis"> Registers a remote Cohesity Cluster with the local Cohesity Cluster. </para> <para type="description"> Registers a remote Cohesity Cluster with the local Cohesity Cluster. </para> </summary> <example> <para>PS></para> <code> Register-CohesityRemoteCluster -RemoteClusterIps 10.2.37.210 -RemoteClusterCredential (Get-Credential) -EnableReplication -EnableRemoteAccess -StorageDomainPairs @{LocalStorageDomainId=5;LocalStorageDomainName="DefaultStorageDomain";RemoteStorageDomainId=5;RemoteStorageDomainName="DefaultStorageDomain"} </code> <para> Registers a new remote Cohesity Cluster with Cluster VIP (10.2.37.210) with the local Cohesity Cluster with the specified parameters. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.RemoteCluster.RegisterCohesityRemoteCluster.RemoteClusterIps"> <summary> <para type="description"> Remote cluster VIP or node IP addresses. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.RemoteCluster.RegisterCohesityRemoteCluster.RemoteClusterCredential"> <summary> <para type="description"> User credentials for the remote cluster. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.RemoteCluster.RegisterCohesityRemoteCluster.EnableRemoteAccess"> <summary> <para type="description"> If specified, enables management of the remote cluster from the local cluster. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.RemoteCluster.RegisterCohesityRemoteCluster.EnableReplication"> <summary> <para type="description"> If specified, indicates that the remote cluster will be used for replication. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.RemoteCluster.RegisterCohesityRemoteCluster.EnableOutBoundCompression"> <summary> <para type="description"> If specified, compresses the outbound data when transferring the replication data over the network to the remote cluster. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.RemoteCluster.RegisterCohesityRemoteCluster.StorageDomainPairs"> <summary> <para type="description"> If specified, compresses the outbound data when transferring the replication data over the network to the remote cluster. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.RemoteCluster.RegisterCohesityRemoteCluster.EncryptionKey"> <summary> <para type="description"> Specifies the encryption key used for encrypting the replication data from a local Cluster to a remote Cluster. This key can be obtained by running New-CohesityReplicationEncryptionKey. If a key is not specified, replication traffic encryption is disabled. When Snapshots are replicated from a local Cluster to a remote Cluster, the encryption key specified on the local Cluster must be the same as the key specified on the remote Cluster. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.RemoteCluster.RegisterCohesityRemoteCluster.BandwidthLimitMbps"> <summary> <para type="description"> Specifies the maximum allowed data transfer rate between the local Cluster and remote Cluster. The value is specified in MB per second. If not set, the data transfer rate is not limited. </para> </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.RemoteCluster.SetCohesityRemoteCluster"> <summary> <para type="synopsis"> Updates a remote cluster registered with the Cohesity Cluster. </para> <para type="description"> Returns the updated remote cluster. </para> </summary> <example> <para>PS></para> <code> $remoteCluster = Get-CohesityRemoteCluster $remoteCluster.AllEndpointsReachable = $true Set-CohesityRemoteCluster -RemoteCluster $remoteCluster </code> <para> Updates a remote cluster with the specified parameters. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.RemoteCluster.SetCohesityRemoteCluster.RemoteCluster"> <summary> <para type="description"> The updated remote cluster. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.RemoteCluster.SetCohesityRemoteCluster.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.RemoteCluster.SetCohesityRemoteCluster.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.RemoteCluster.UnregisterCohesityRemoteCluster"> <summary> <para type="synopsis"> Unregisters the specified remote cluster from the Cohesity Cluster. </para> <para type="description"> Unregisters the specified remote cluster from the Cohesity Cluster. </para> </summary> <example> <para>PS></para> <code> Unregister-CohesityRemoteCluster -ClusterId 7539516053202252 </code> <para> Unregisters the given remote cluster. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.RemoteCluster.UnregisterCohesityRemoteCluster.Id"> <summary> <para type="description"> Specifies a unique id of the remote cluster. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.RemoteCluster.UnregisterCohesityRemoteCluster.RemoteCluster"> <summary> <para type="description"> Specifies a remote cluster object. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.RemoteCluster.UnregisterCohesityRemoteCluster.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.RemoteCluster.UnregisterCohesityRemoteCluster.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Role.GetCohesityRole"> <summary> <para type="synopsis"> Gets the roles defined on the Cohesity Cluster. </para> <para type="description"> Gets the roles defined on the Cohesity Cluster. </para> </summary> <example> <para>PS></para> <code> Get-CohesityRole -Name COHESITY_ADMIN </code> <para> Gets the role with the name COHESITY_ADMIN. </para> </example> <example> <para>PS></para> <code> Get-CohesityRole </code> <para> Gets all the roles on the Cohesity Cluster. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Role.GetCohesityRole.Name"> <summary> <para type="description"> Specifies the name of the Role. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.Role.GetCohesityRole.ProcessRecord"> <summary> Process Records </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.User.GetCohesityUser"> <summary> <para type="synopsis"> Gets the users defined on the Cohesity Cluster. </para> <para type="description"> Gets the users defined on the Cohesity Cluster. </para> </summary> <example> <para>PS></para> <code> Get-CohesityUser -Names admin,test-user </code> <para> Gets the details of the users with the names "admin" and "test-user". </para> </example> <example> <para>PS></para> <code> Get-CohesityUser -Domain example.com </code> <para> Gets the details of all the users with the domain name as "example.com". </para> </example> <example> <para>PS></para> <code> Get-CohesityUser </code> <para> Gets the details of all the users on the Cohesity Cluster. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.User.GetCohesityUser.Names"> <summary> <para type="description"> Specifies a list of user names to filter the results. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.User.GetCohesityUser.EmailAddresses"> <summary> <para type="description"> Specifies a list of email addresses to filter the results. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.User.GetCohesityUser.Domain"> <summary> <para type="description"> Specifies the domain name to filter the results. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.User.GetCohesityUser.ProcessRecord"> <summary> Process Records </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.User.NewCohesityUser"> <summary> <para type="synopsis"> Creates a new Cohesity User. </para> <para type="description"> Returns the created Cohesity User. </para> </summary> <example> <para>PS></para> <code> New-CohesityUser -Name test-user -Password password -Roles COHESITY_ADMIN </code> <para> Creates a new Cohesity User in default LOCAL domain called "test-user" with COHESITY_ADMIN role. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.User.NewCohesityUser.Name"> <summary> <para type="description"> Specifies the name of the User to be created. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.User.NewCohesityUser.Password"> <summary> <para type="description"> Specifies the password for the User to be created. This is mandatory in case of a LOCAL user. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.User.NewCohesityUser.Roles"> <summary> <para type="description"> Specifies one or more roles for the User to be created. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.User.NewCohesityUser.Domain"> <summary> <para type="description"> Specifies the fully qualified domain name of an Active Directory or LOCAL for the default domain. A user is uniquely identified by combination of the username and the domain. If not specified, the default domain is used. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.User.NewCohesityUser.EmailAddress"> <summary> <para type="description"> Specifies the email address for the User to be created. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.User.NewCohesityUser.Description"> <summary> <para type="description"> Specifies the description for the User to be created. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.User.NewCohesityUser.Restricted"> <summary> <para type="description"> Specifies whether the created user has restricted access. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.User.NewCohesityUser.EffectiveTime"> <summary> <para type="description"> Specifies the effective time for this User. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.User.NewCohesityUser.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.User.NewCohesityUser.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Utility.ConvertCohesityDateTimeToUsecs"> <summary> <para type="synopsis"> Converts the DateTime format to unix timestamp in microseconds. </para> <para type="description"> Converts the DateTime format to unix timestamp in microseconds. </para> </summary> <example> <para>PS></para> <code> Convert-CohesityDateTimeToUsecs -DateTime "Tuesday, September 18, 2018 5:40:12 PM" </code> <para> Converts the DateTime format to its corresponding unix timestamp in microseconds such as: 1537272612000000. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Utility.ConvertCohesityDateTimeToUsecs.DateTime"> <summary> <para type="description"> Timestamp in DateTime format. </para> </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.Utility.ConvertCohesityUsecsToDateTime"> <summary> <para type="synopsis"> Converts the unix timestamp in microseconds to DateTime format. </para> <para type="description"> Converts the unix timestamp in microseconds to DateTime format. </para> </summary> <example> <para>PS></para> <code> Convert-CohesityUsecsToDateTime -Usecs 1537272612321018 </code> <para> Converts the unix timestamp in microseconds to its corresponding DateTime value such as: Tuesday, September 18, 2018 5:10:12 AM. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.Utility.ConvertCohesityUsecsToDateTime.Usecs"> <summary> <para type="description"> Timestamp in microseconds. </para> </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.View.AddCohesityViewShare"> <summary> <para type="synopsis"> Adds a new share to a Cohesity View. </para> <para type="description"> Adds a new share to a Cohesity View. </para> </summary> <example> <para>PS></para> <code> Add-CohesityViewShare -ViewName 'Test-View' -ShareName 'Test-Share' -ViewPath '/' </code> <para> Adds a new share called 'Test-Share' using a Cohesity View named 'Test-View' mapped to the directory path '/' inside the View. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.AddCohesityViewShare.ViewName"> <summary> <para type="description"> Specifies the name of the View. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.AddCohesityViewShare.ShareName"> <summary> <para type="description"> Specifies the name of the Share to be created. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.AddCohesityViewShare.ViewPath"> <summary> <para type="description"> Specifies a directory path inside the View to be mounted using this Share. If not specified, '/' will be used as the default path. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.View.AddCohesityViewShare.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.View.AddCohesityViewShare.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.View.GetCohesityView"> <summary> <para type="synopsis"> Gets a list of views filtered by specified parameters. </para> <para type="description"> If no parameters are specified, all views on the Cohesity Cluster are returned. Specifying parameters filters the results that are returned. </para> <para type="description"> NOTE: If MaxCount is specified 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. </para> </summary> <example> <para>PS></para> <code> Get-CohesityView -ViewNames Test-view </code> <para> Displays the view with the name "Test-view". </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.GetCohesityView.IncludeInactive"> <summary> <para type="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 is not set. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.GetCohesityView.MatchAliasNames"> <summary> <para type="description"> If set, View aliases are also matched with the names specified by ViewNames parameter. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.GetCohesityView.ViewNames"> <summary> <para type="description"> Filter by a list of View names. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.GetCohesityView.ViewBoxIds"> <summary> <para type="description"> Filter by a list of Storage Domains (View Boxes) specified by id. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.GetCohesityView.ViewBoxNames"> <summary> <para type="description"> Filter by a list of View Box names. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.GetCohesityView.MatchPartialNames"> <summary> <para type="description"> If set, the names in ViewNames are matched by prefix rather than an exact match. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.GetCohesityView.MaxCount"> <summary> <para type="description"> Specifies a limit on the number of Views returned. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.GetCohesityView.MaxViewId"> <summary> <para type="description"> If the number of Views to return exceeds the MaxCount specified, specify the id of the last View from the viewList in the previous response to get the next set of Views. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.GetCohesityView.JobIds"> <summary> <para type="description"> Filter by Protection Job ids. Return Views that are being protected by listed Jobs, which are specified by ids. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.GetCohesityView.SortByLogicalUsage"> <summary> <para type="description"> If set, the results are sorted in descending order by logical usage. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.GetCohesityView.IncludeStats"> <summary> <para type="description"> If set, the results will include statistics. </para> </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.View.GetCohesityViewShare"> <summary> <para type="synopsis"> Gets a list of shares associated with a view. </para> <para type="description"> Gets a list of shares associated with a view. </para> </summary> <example> <para>PS></para> <code> Get-CohesityViewShare -ViewName Test-view </code> <para> Displays the shares associated with a view with the name "Test-view". </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.GetCohesityViewShare.ViewName"> <summary> <para type="description"> Name of the View </para> </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.View.NewCohesityView"> <summary> <para type="synopsis"> Creates a new Cohesity View. </para> <para type="description"> Returns the created Cohesity View. </para> </summary> <example> <para>PS></para> <code> New-CohesityView -Name 'Test-View' -AccessProtocol KS3Only -StorageDomainName 'Test-Storage-Domain' </code> <para> Creates a new Cohesity View only accessible via S3 protocol using Storage Domain with name 'Test-Storage-Domain'. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.NewCohesityView.Name"> <summary> <para type="description"> Specifies the name of the View to be created. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.NewCohesityView.Description"> <summary> <para type="description"> Specifies the description for this View. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.NewCohesityView.AccessProtocol"> <summary> <para type="description"> Specifies the supported protocols for this View. If not specified, default is kAll which means all protocols are supported. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.NewCohesityView.QosPolicy"> <summary> <para type="description"> Specifies the Quality of Service (QoS) Policy for this View. If not specified, the default is 'Backup Target Low' </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.NewCohesityView.StorageDomainName"> <summary> <para type="description"> Specifies the Storage Domain name for this View. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.NewCohesityView.LogicalQuotaInBytes"> <summary> <para type="description"> Specifies an optional quota limit on the usage allowed for this view. This limit is specified in bytes. If no value is specified, there is no limit. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.NewCohesityView.AlertQuotaInBytes"> <summary> <para type="description"> Specifies if an alert should be triggered when the usage of this view exceeds this quota limit. This limit is optional and is specified in bytes. If no value is specified, there is no limit. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.NewCohesityView.CaseInsensitiveNames"> <summary> <para type="description"> Specifies whether to support case insensitive file/folder names. This is not enabled by default. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.NewCohesityView.BrowsableShares"> <summary> <para type="description"> Specifies whether the shares from this View are browsable. This is not enabled by default. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.NewCohesityView.SmbAccessBasedEnumeration"> <summary> <para type="description"> Specifies whether SMB Access Based Enumeration is enabled. This is not enabled by default. </para> </summary> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.NewCohesityView.DisableInlineDedupAndCompression"> <summary> <para type="description"> Specifies whether inline deduplication and compression settings inherited from the Storage Domain should be disabled for this View. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.View.NewCohesityView.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.View.NewCohesityView.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.View.RemoveCohesityView"> <summary> <para type="synopsis"> Removes a Cohesity View. </para> <para type="description"> Returns success if the view is deleted. </para> </summary> <example> <para>PS></para> <code> Remove-CohesityView -Name "Test-View" </code> <para> Removes a view with the name "Test-View". </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.RemoveCohesityView.Name"> <summary> <para type="description"> Specifies the name of the View to be deleted. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.View.RemoveCohesityView.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.View.RemoveCohesityView.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.View.RemoveCohesityViewShare"> <summary> <para type="synopsis"> Removes a Share associated with a Cohesity View . </para> <para type="description"> Returns success if the Share is deleted. </para> </summary> <example> <para>PS></para> <code> Remove-CohesityViewShare -ShareName "Test-Share" </code> <para> Removes a share with the name "Test-Share". </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.RemoveCohesityViewShare.ShareName"> <summary> <para type="description"> Specifies the name of the View to be deleted. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.View.RemoveCohesityViewShare.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.View.RemoveCohesityViewShare.ProcessRecord"> <summary> Process </summary> </member> <member name="T:Cohesity.Powershell.Cmdlets.View.SetCohesityView"> <summary> <para type="synopsis"> Updates a Cohesity View. </para> <para type="description"> Returns the updated Cohesity View. </para> </summary> <example> <para>PS></para> <code> Set-CohesityView -View $view </code> <para> Updates a Cohesity View. </para> </example> <example> <para>PS></para> <code> $view = Get-CohesityView -ViewNames “Cohesity_View” $SubnetWhitelists = New-Object 'System.Collections.Generic.List[Cohesity.Model.Subnet]' $subnet = New-Object -TypeName Cohesity.Model.Subnet("") -Property @{NetmaskIp4="255.255.255.0" Description="whitelist linux";Ip="10.2.146.241";NfsAccess=3; SmbAccess=2;NfsRootSquash=$False} $SubnetWhitelists.Add($subnet) $view.SubnetWhitelist= $SubnetWhitelists Set-CohesityView -View $view </code> <para> Override global whitelist. </para> </example> </member> <member name="P:Cohesity.Powershell.Cmdlets.View.SetCohesityView.View"> <summary> <para type="description"> The updated View. </para> </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.View.SetCohesityView.BeginProcessing"> <summary> Preprocess </summary> </member> <member name="M:Cohesity.Powershell.Cmdlets.View.SetCohesityView.ProcessRecord"> <summary> Process </summary> </member> <member name="M:Cohesity.Powershell.Common.RestApiClient.Disconnect"> <summary> When disconnecting from cluster, remove client so that there is no way to connect from current state. </summary> </member> <member name="M:Cohesity.Powershell.Common.TimeZoneInfoExtensions.GetOlsonTimeZone"> <summary> Converts an Olson time zone ID to a Windows time zone ID. </summary> <param name="olsonTimeZoneId">An Olson time zone ID. See http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/zone_tzid.html. </param> <returns> The string corresponding to the Olson time zone ID, or null if you passed in an invalid time zone ID. </returns> <remarks> See http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/zone_tzid.html </remarks> </member> <member name="T:Cohesity.Session"> <summary> Session information shared by cmdlets. </summary> </member> <member name="P:Cohesity.Session.ApiClient"> <summary> The network client used for communicating with Cohestiy REST API. </summary> </member> </members> </doc> |