Cohesity.Powershell.Core.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Restore-CohesityAcropolisVM --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Restore-CohesityAcropolisVM</command:name> <command:verb>Restore</command:verb> <command:noun>CohesityAcropolisVM</command:noun> <maml:description> <maml:para>Restores the specified Nutanix Acropolis virtual machine from a previous backup.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Restores the specified Nutanix Acropolis virtual machine from a previous backup.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Restore-CohesityAcropolisVM</maml:name> <!-- Parameter: JobId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the job id that backed up this VM and will be used for this restore.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SourceId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceId</maml:name> <maml:description> <maml:para>Specifies the source id of the VM to be restored.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: TaskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>Specifies the name of the restore task.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisableNetwork --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableNetwork</maml:name> <maml:description> <maml:para>Specifies whether the network should be left in disabled state. Attached network is enabled by default. Use this switch to disable it.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: JobRunId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobRunId</maml:name> <maml:description> <maml:para>Specifies the job run id that captured the snapshot for this VM. If not specified the latest run is used.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PoweredOn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PoweredOn</maml:name> <maml:description> <maml:para>Specifies the power state of the recovered VM. By default, the VM is powered off.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VmNamePrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmNamePrefix</maml:name> <maml:description> <maml:para>Specifies the prefix to add to the name of the restored VM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VmNameSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmNameSuffix</maml:name> <maml:description> <maml:para>Specifies the suffix to add to the name of the restored VM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TaskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>Specifies the name of the restore task.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceId</maml:name> <maml:description> <maml:para>Specifies the source id of the VM to be restored.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: JobId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the job id that backed up this VM and will be used for this restore.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: JobRunId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobRunId</maml:name> <maml:description> <maml:para>Specifies the job run id that captured the snapshot for this VM. If not specified the latest run is used.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VmNamePrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmNamePrefix</maml:name> <maml:description> <maml:para>Specifies the prefix to add to the name of the restored VM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VmNameSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmNameSuffix</maml:name> <maml:description> <maml:para>Specifies the suffix to add to the name of the restored VM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisableNetwork --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableNetwork</maml:name> <maml:description> <maml:para>Specifies whether the network should be left in disabled state. Attached network is enabled by default. Use this switch to disable it.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PoweredOn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PoweredOn</maml:name> <maml:description> <maml:para>Specifies the power state of the recovered VM. By default, the VM is powered off.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Restore-CohesityAcropolisVM -TaskName "Test-Restore" -SourceId 2 -JobId 8 -VmNamePrefix "copy-" -DisableNetwork -PoweredOn</dev:code> <dev:remarks> <maml:para>Restores the Nutanix Acropolis virtual machine with the given source id using the latest run of job id 8.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CohesityAlert --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CohesityAlert</command:name> <command:verb>Get</command:verb> <command:noun>CohesityAlert</command:noun> <maml:description> <maml:para>Gets a list of alerts triggered on the Cohesity Cluster filtered by the specified parameters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a list of alerts triggered on the Cohesity Cluster filtered by the specified parameters.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityAlert</maml:name> <!-- Parameter: MaxAlerts --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxAlerts</maml:name> <maml:description> <maml:para>Limit the number of alerts to the specified value. The newest alerts are returned upto the limit specified.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AlertCategories --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AlertCategories</maml:name> <maml:description> <maml:para>Filter by a list of alert categories such as 'kDisk’, 'kNode’, 'kCluster’, 'kNodeHealth’, 'kClusterHealth’, 'kBackupRestore’, ‘kEncryption’ and 'kArchivalRestore’.</maml:para> </maml:description> <command:parameterValue required="true">AlertCategoryEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.Alert+AlertCategoryEnum[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AlertIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AlertIds</maml:name> <maml:description> <maml:para>Filter by a list of alert Ids.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AlertSeverities --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AlertSeverities</maml:name> <maml:description> <maml:para>Filter by a list of alert severities such as 'kCritical’, ‘kWarning’ and 'kInfo’.</maml:para> </maml:description> <command:parameterValue required="true">SeverityEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.Alert+SeverityEnum[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AlertStates --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AlertStates</maml:name> <maml:description> <maml:para>Filter by a list of alert states such as ‘kOpen’ and 'kResolved’.</maml:para> </maml:description> <command:parameterValue required="true">AlertStateEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.Alert+AlertStateEnum[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AlertTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AlertTypes</maml:name> <maml:description> <maml:para>Filter by a list of alert types.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Filter by end date and time by specifying a unix epoch time in microseconds.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResolutionIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResolutionIds</maml:name> <maml:description> <maml:para>Filter by a list of resolution Ids.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Filter by start date and time by specifying a unix epoch time in microseconds.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: MaxAlerts --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxAlerts</maml:name> <maml:description> <maml:para>Limit the number of alerts to the specified value. The newest alerts are returned upto the limit specified.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AlertCategories --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AlertCategories</maml:name> <maml:description> <maml:para>Filter by a list of alert categories such as 'kDisk’, 'kNode’, 'kCluster’, 'kNodeHealth’, 'kClusterHealth’, 'kBackupRestore’, ‘kEncryption’ and 'kArchivalRestore’.</maml:para> </maml:description> <command:parameterValue required="true">AlertCategoryEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.Alert+AlertCategoryEnum[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AlertStates --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AlertStates</maml:name> <maml:description> <maml:para>Filter by a list of alert states such as ‘kOpen’ and 'kResolved’.</maml:para> </maml:description> <command:parameterValue required="true">AlertStateEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.Alert+AlertStateEnum[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AlertSeverities --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AlertSeverities</maml:name> <maml:description> <maml:para>Filter by a list of alert severities such as 'kCritical’, ‘kWarning’ and 'kInfo’.</maml:para> </maml:description> <command:parameterValue required="true">SeverityEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.Alert+SeverityEnum[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResolutionIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResolutionIds</maml:name> <maml:description> <maml:para>Filter by a list of resolution Ids.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AlertIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AlertIds</maml:name> <maml:description> <maml:para>Filter by a list of alert Ids.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AlertTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AlertTypes</maml:name> <maml:description> <maml:para>Filter by a list of alert types.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Filter by start date and time by specifying a unix epoch time in microseconds.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Filter by end date and time by specifying a unix epoch time in microseconds.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Alert --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.Alert</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Get-CohesityAlert -MaxAlerts 10</dev:code> <dev:remarks> <maml:para>Gets a list of most recent 10 alerts triggered on the Cohesity Cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CohesityAlertResolution --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CohesityAlertResolution</command:name> <command:verb>Get</command:verb> <command:noun>CohesityAlertResolution</command:noun> <maml:description> <maml:para>Returns all Alert Resolution objects found on the Cohesity Cluster that match the filter criteria specified using parameters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityAlertResolution</maml:name> <!-- Parameter: MaxAlerts --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxAlerts</maml:name> <maml:description> <maml:para>Limit the number of alerts to the specified value. The newest alerts are returned upto the limit specified.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AlertIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AlertIds</maml:name> <maml:description> <maml:para>Filter by a list of alert Ids.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Filter by end date and time by specifying a unix epoch time in microseconds.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResolutionIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResolutionIds</maml:name> <maml:description> <maml:para>Filter by a list of resolution Ids.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Filter by start date and time by specifying a unix epoch time in microseconds.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: MaxAlerts --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxAlerts</maml:name> <maml:description> <maml:para>Limit the number of alerts to the specified value. The newest alerts are returned upto the limit specified.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResolutionIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResolutionIds</maml:name> <maml:description> <maml:para>Filter by a list of resolution Ids.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AlertIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AlertIds</maml:name> <maml:description> <maml:para>Filter by a list of alert Ids.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Filter by start date and time by specifying a unix epoch time in microseconds.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Filter by end date and time by specifying a unix epoch time in microseconds.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: AlertResolution --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.AlertResolution</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Get-CohesityAlertResolution -MaxAlerts 10</dev:code> <dev:remarks> <maml:para>Gets a list of most recent 10 alertResoulitions triggered on the Cohesity Cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Unregister-CohesityApplicationServer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Unregister-CohesityApplicationServer</command:name> <command:verb>Unregister</command:verb> <command:noun>CohesityApplicationServer</command:noun> <maml:description> <maml:para>Unregisters the application server (such as SQL) running on the specified protection source from the Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Unregisters the application server (such as SQL) running on the specified protection source from the Cohesity Cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Unregister-CohesityApplicationServer</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies a unique id of the protection source.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Unregister-CohesityApplicationServer</maml:name> <!-- Parameter: ProtectionSource --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ProtectionSource</maml:name> <maml:description> <maml:para>Specifies a protection source object.</maml:para> </maml:description> <command:parameterValue required="true">ProtectionSourceNode</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionSourceNode</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies a unique id of the protection source.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ProtectionSource --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ProtectionSource</maml:name> <maml:description> <maml:para>Specifies a protection source object.</maml:para> </maml:description> <command:parameterValue required="true">ProtectionSourceNode</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionSourceNode</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies a unique id of the protection source.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Cohesity.Model.ProtectionSourceNode</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies a protection source object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Unregister-CohesityApplicationServer -Id 12</dev:code> <dev:remarks> <maml:para>Unregisters the application server running on the protection source with Id 12 from Cohesity Cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CohesityAuditLog --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CohesityAuditLog</command:name> <command:verb>Get</command:verb> <command:noun>CohesityAuditLog</command:noun> <maml:description> <maml:para>Gets a list of audit logs generated on the Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If no parameters are specified, all audit logs currently on the Cohesity Cluster are returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityAuditLog</maml:name> <!-- Parameter: Actions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Actions</maml:name> <maml:description> <maml:para>Filter by the actions that generate Cluster audit logs such as Activate, Cancel, Clone, Create, etc.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domains --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Domains</maml:name> <maml:description> <maml:para>Filter by domains of users who caused the actions that trigger Cluster audit logs.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Filter by end date and time by specifying a unix epoch time in microseconds.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EntityTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityTypes</maml:name> <maml:description> <maml:para>Filter by entity types involved in the actions that generate the Cluster audit logs, such as User, Protection Job, View, etc.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PageCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PageCount</maml:name> <maml:description> <maml:para>Limit the number of items to return in the response for pagination purposes. Default value is 1000.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Search --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Search</maml:name> <maml:description> <maml:para>Filter by matching a substring in entity name or details of the Cluster audit logs.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: StartIndex --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartIndex</maml:name> <maml:description> <maml:para>Specifies an index number that can be used to return subsets of items in multiple requests.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Filter by start date and time by specifying a unix epoch time in microseconds.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserNames</maml:name> <maml:description> <maml:para>Filter by user names who caused the actions that generate Cluster Audit Logs.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UserNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserNames</maml:name> <maml:description> <maml:para>Filter by user names who caused the actions that generate Cluster Audit Logs.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domains --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Domains</maml:name> <maml:description> <maml:para>Filter by domains of users who caused the actions that trigger Cluster audit logs.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EntityTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityTypes</maml:name> <maml:description> <maml:para>Filter by entity types involved in the actions that generate the Cluster audit logs, such as User, Protection Job, View, etc.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Actions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Actions</maml:name> <maml:description> <maml:para>Filter by the actions that generate Cluster audit logs such as Activate, Cancel, Clone, Create, etc.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Filter by start date and time by specifying a unix epoch time in microseconds.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Filter by end date and time by specifying a unix epoch time in microseconds.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Search --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Search</maml:name> <maml:description> <maml:para>Filter by matching a substring in entity name or details of the Cluster audit logs.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: StartIndex --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartIndex</maml:name> <maml:description> <maml:para>Specifies an index number that can be used to return subsets of items in multiple requests.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PageCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PageCount</maml:name> <maml:description> <maml:para>Limit the number of items to return in the response for pagination purposes. Default value is 1000.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ClusterAuditLog --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.ClusterAuditLog</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Get-CohesityAuditLog -UserNames admin</dev:code> <dev:remarks> <maml:para>All audit logs related to the username admin are displayed.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CohesityClone --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CohesityClone</command:name> <command:verb>Remove</command:verb> <command:noun>CohesityClone</command:noun> <maml:description> <maml:para>Removes or tears down a Cohesity clone.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes or tears down the Cohesity clone created by the specified task id.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-CohesityClone</maml:name> <!-- Parameter: TaskId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the task id that created the clone to be removed.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TaskId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the task id that created the clone to be removed.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the task id that created the clone to be removed.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Remove-CohesityClone -TaskId 1234</dev:code> <dev:remarks> <maml:para>Tears down the clone previously created by task id 1234.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Connect-CohesityCluster --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Connect-CohesityCluster</command:name> <command:verb>Connect</command:verb> <command:noun>CohesityCluster</command:noun> <maml:description> <maml:para>Connects to a Cohesity Cluster and acquires an authentication token.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: UsingCreds --> <command:syntaxItem> <maml:name>Connect-CohesityCluster</maml:name> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>User credentials for the Cohesity Cluster. To login as a tenant use the user name as LOCAL\user1@tenant1</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>The FQDN or IP address of any node in the Cohesity Cluster or Cluster VIP.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OtpType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OtpType</maml:name> <maml:description> <maml:para>Specifies OTP type for MFA verification. 'Totp' implies the code is TOTP. 'Email' implies the code is email OTP.</maml:para> <maml:para>Possible values: Totp, Email</maml:para> </maml:description> <command:parameterValue required="true">OtpTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.AccessTokenCredential+OtpTypeEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Totp</command:parameterValue> <command:parameterValue required="false" variableLength="false">Email</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The port to use to connect to Cohesity Cluster.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>443</dev:defaultValue> </command:parameter> <!-- Parameter: UseMFA --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseMFA</maml:name> <maml:description> <maml:para>Do MFA required ?</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: UsingAPIKey --> <command:syntaxItem> <maml:name>Connect-CohesityCluster</maml:name> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>The FQDN or IP address of any node in the Cohesity Cluster or Cluster VIP.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: APIKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIKey</maml:name> <maml:description> <maml:para>Cohesity API key</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OtpType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OtpType</maml:name> <maml:description> <maml:para>Specifies OTP type for MFA verification. 'Totp' implies the code is TOTP. 'Email' implies the code is email OTP.</maml:para> <maml:para>Possible values: Totp, Email</maml:para> </maml:description> <command:parameterValue required="true">OtpTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.AccessTokenCredential+OtpTypeEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Totp</command:parameterValue> <command:parameterValue required="false" variableLength="false">Email</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The port to use to connect to Cohesity Cluster.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>443</dev:defaultValue> </command:parameter> <!-- Parameter: UseMFA --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseMFA</maml:name> <maml:description> <maml:para>Do MFA required ?</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: UsingSessionId --> <command:syntaxItem> <maml:name>Connect-CohesityCluster</maml:name> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>The FQDN or IP address of any node in the Cohesity Cluster or Cluster VIP.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OtpType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OtpType</maml:name> <maml:description> <maml:para>Specifies OTP type for MFA verification. 'Totp' implies the code is TOTP. 'Email' implies the code is email OTP.</maml:para> <maml:para>Possible values: Totp, Email</maml:para> </maml:description> <command:parameterValue required="true">OtpTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.AccessTokenCredential+OtpTypeEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Totp</command:parameterValue> <command:parameterValue required="false" variableLength="false">Email</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The port to use to connect to Cohesity Cluster.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>443</dev:defaultValue> </command:parameter> <!-- Parameter: SessionId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>Cohesity Session Id key</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseMFA --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseMFA</maml:name> <maml:description> <maml:para>Do MFA required ?</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>The FQDN or IP address of any node in the Cohesity Cluster or Cluster VIP.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The port to use to connect to Cohesity Cluster.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>443</dev:defaultValue> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>User credentials for the Cohesity Cluster. To login as a tenant use the user name as LOCAL\user1@tenant1</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: APIKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIKey</maml:name> <maml:description> <maml:para>Cohesity API key</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>Cohesity Session Id key</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseMFA --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseMFA</maml:name> <maml:description> <maml:para>Do MFA required ?</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: OtpType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OtpType</maml:name> <maml:description> <maml:para>Specifies OTP type for MFA verification. 'Totp' implies the code is TOTP. 'Email' implies the code is email OTP.</maml:para> <maml:para>Possible values: Totp, Email</maml:para> </maml:description> <command:parameterValue required="true">OtpTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.AccessTokenCredential+OtpTypeEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Totp</command:parameterValue> <command:parameterValue required="false" variableLength="false">Email</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Connect-CohesityCluster -Server 192.168.1.100 -Credential (Get-Credential)</dev:code> <dev:remarks> <maml:para>Connects to a Cohesity Cluster at the address "192.168.1.100" using the provided credentials.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev: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))</dev:code> <dev:remarks> <maml:para>Connects to a Cohesity Cluster at the address "192.168.1.100" using the active directory user, by appending fully qualified domain name(mydomain.com) to the user.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev: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))</dev:code> <dev:remarks> <maml:para>Connects to a Cohesity Cluster at the address "192.168.1.100" for a user "user1" in the tenant "tenant1".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Connect-CohesityCluster -Server 192.168.1.100 -APIKey "00000000-0000-0000-0000-000000000000"</dev:code> <dev:remarks> <maml:para>Connects to a Cohesity Cluster at the address "192.168.1.100" using the API Key (supported 6.5.1d onwards).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Connect-CohesityCluster -Server 192.168.1.100 -sessionId "sessionId"</dev:code> <dev:remarks> <maml:para>Connects to a Cohesity Cluster at the address "192.168.1.100" using the Session Id.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Connect-CohesityCluster -Server 192.168.1.100 -UseMFA -OtpType Email</dev:code> <dev:remarks> <maml:para>Connects to a Cohesity Cluster at the address "192.168.1.100" using Multi-Factor Authentication(MFA). By default, OtpType will be considered as Totp if not provided. On trying to connect to the cluster using MFA, user will be prompted to provide OTP code.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Disconnect-CohesityCluster --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disconnect-CohesityCluster</command:name> <command:verb>Disconnect</command:verb> <command:noun>CohesityCluster</command:noun> <maml:description> <maml:para>Disconnects from the Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Disconnects from the Cohesity Cluster and invalidates the session.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disconnect-CohesityCluster</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Disconnect-CohesityCluster</dev:code> <dev:remarks> <maml:para>Disconnects from the Cohesity Cluster and invalidates the session.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CohesityCluster --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CohesityCluster</command:name> <command:verb>Get</command:verb> <command:noun>CohesityCluster</command:noun> <maml:description> <maml:para>Gets basic information about the Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets basic information about the Cohesity Cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityCluster</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: BasicClusterInfo --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.BasicClusterInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Get-CohesityCluster</dev:code> <dev:remarks> <maml:para>Gets basic information about the Cohesity Cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CohesityClusterConfiguration --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CohesityClusterConfiguration</command:name> <command:verb>Get</command:verb> <command:noun>CohesityClusterConfiguration</command:noun> <maml:description> <maml:para>Gets the Cohesity Cluster configuration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If FetchStats parameter is specified, returns stats along with the Cohesity Cluster configuration.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityClusterConfiguration</maml:name> <!-- Parameter: FetchStats --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FetchStats</maml:name> <maml:description> <maml:para>If specified, also gets stats along with the Cohesity Cluster configuration.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: FetchStats --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FetchStats</maml:name> <maml:description> <maml:para>If specified, also gets stats along with the Cohesity Cluster configuration.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Cluster --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.Cluster</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Get-CohesityClusterConfiguration -FetchStats </dev:code> <dev:remarks> <maml:para>Returns stats along with the Cohesity Cluster configuration.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CohesityClusterConfiguration --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-CohesityClusterConfiguration</command:name> <command:verb>Set</command:verb> <command:noun>CohesityClusterConfiguration</command:noun> <maml:description> <maml:para>Updates the Cohesity Cluster configuration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the Updated Cohesity Cluster configuration.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-CohesityClusterConfiguration</maml:name> <!-- Parameter: ClusterConfiguration --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ClusterConfiguration</maml:name> <maml:description> <maml:para>The updated Cohesity Cluster Configuration.</maml:para> </maml:description> <command:parameterValue required="true">Cluster</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.Cluster</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ClusterConfiguration --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ClusterConfiguration</maml:name> <maml:description> <maml:para>The updated Cohesity Cluster Configuration.</maml:para> </maml:description> <command:parameterValue required="true">Cluster</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.Cluster</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Cohesity.Model.Cluster</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The updated Cohesity Cluster Configuration.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Cluster --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.Cluster</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>$config = Get-CohesityClusterConfiguration $config.AssignedRacksCount = 10 Set-CohesityClusterConfiguration -ClusterConfiguration $config</dev:code> <dev:remarks> <maml:para>Updates the Cohesity Cluster configuration with specified parameters.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CohesityClusterPartition --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CohesityClusterPartition</command:name> <command:verb>Get</command:verb> <command:noun>CohesityClusterPartition</command:noun> <maml:description> <maml:para>Gets a list of partitions in the Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a list of partitions in the Cohesity Cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityClusterPartition</maml:name> <!-- Parameter: Ids --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ids</maml:name> <maml:description> <maml:para>Filter by a list of cluster partition ids.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Names --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Names</maml:name> <maml:description> <maml:para>Filter by a list of cluster partition names.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Ids --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ids</maml:name> <maml:description> <maml:para>Filter by a list of cluster partition ids.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Names --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Names</maml:name> <maml:description> <maml:para>Filter by a list of cluster partition names.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ClusterPartition --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.ClusterPartition</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Get-CohesityClusterPartition</dev:code> <dev:remarks> <maml:para>Gets a list of partitions in the Cohesity Cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Convert-CohesityDateTimeToUsecs --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Convert-CohesityDateTimeToUsecs</command:name> <command:verb>Convert</command:verb> <command:noun>CohesityDateTimeToUsecs</command:noun> <maml:description> <maml:para>Converts the DateTime format to unix timestamp in microseconds.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Converts the DateTime format to unix timestamp in microseconds.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Convert-CohesityDateTimeToUsecs</maml:name> <!-- Parameter: DateTime --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>DateTime</maml:name> <maml:description> <maml:para>Timestamp in DateTime format.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: DateTime --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>DateTime</maml:name> <maml:description> <maml:para>Timestamp in DateTime format.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Timestamp in DateTime format.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Int64 --> <command:returnValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Convert-CohesityDateTimeToUsecs -DateTime "Tuesday, September 18, 2018 5:40:12 PM"</dev:code> <dev:remarks> <maml:para>Converts the DateTime format to its corresponding unix timestamp in microseconds such as: 1537272612000000.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Restore-CohesityFile --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Restore-CohesityFile</command:name> <command:verb>Restore</command:verb> <command:noun>CohesityFile</command:noun> <maml:description> <maml:para>Restores the specified files or folders from a previous backup.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Restores the specified files or folders from a previous backup.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Restore-CohesityFile</maml:name> <!-- Parameter: FileNames --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FileNames</maml:name> <maml:description> <maml:para>Specifies the full names of the files or folders to be restored.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JobId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the job id that backed up the files and will be used for this restore.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SourceId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceId</maml:name> <maml:description> <maml:para>Specifies the id of the original protection source (that was backed up) containing the files and folders.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: TargetSourceId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetSourceId</maml:name> <maml:description> <maml:para>Specifies the id of the target source (such as a VM or Physical server) where the files and folders are to be restored.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TaskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>Specifies the name of the Restore Task.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ContinueOnError --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ContinueOnError</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DoNotOverwrite --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotOverwrite</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DoNotPreserveAttributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotPreserveAttributes</maml:name> <maml:description> <maml:para>Specifies that the Restore Task should not preserve the original attributes of the files and folders. By default, the original attributes are preserved.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: FileRecoveryMethod --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FileRecoveryMethod</maml:name> <maml:description> <maml:para>Specifies the type of method to be used to perform file recovery.</maml:para> <maml:para>Possible values: KAutoDeploy, KUseExistingAgent, KUseHypervisorAPIs</maml:para> </maml:description> <command:parameterValue required="true">FileRecoveryMethodEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RestoreFilesTaskRequest+FileRecoveryMethodEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KAutoDeploy</command:parameterValue> <command:parameterValue required="false" variableLength="false">KUseExistingAgent</command:parameterValue> <command:parameterValue required="false" variableLength="false">KUseHypervisorAPIs</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: JobRunId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobRunId</maml:name> <maml:description> <maml:para>Specifies the Job Run id that captured the snapshot. If not specified, the latest backup run is used.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewBaseDirectory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewBaseDirectory</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetHostCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetHostCredential</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetHostType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetHostType</maml:name> <maml:description> <maml:para>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.</maml:para> <maml:para>Possible values: KLinux, KWindows, KAix, KSolaris, KSapHana, KSapOracle, KCockroachDB, KMySQL, KOther, KSapSybase, KSapMaxDB, KSapSybaseIQ, KDB2, KSapASE, KMariaDB, KPostgreSQL, KVOS, KHPUX</maml:para> </maml:description> <command:parameterValue required="true">TargetHostTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RestoreFilesTaskRequest+TargetHostTypeEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KLinux</command:parameterValue> <command:parameterValue required="false" variableLength="false">KWindows</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAix</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSolaris</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapHana</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapOracle</command:parameterValue> <command:parameterValue required="false" variableLength="false">KCockroachDB</command:parameterValue> <command:parameterValue required="false" variableLength="false">KMySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">KOther</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapSybase</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapMaxDB</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapSybaseIQ</command:parameterValue> <command:parameterValue required="false" variableLength="false">KDB2</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapASE</command:parameterValue> <command:parameterValue required="false" variableLength="false">KMariaDB</command:parameterValue> <command:parameterValue required="false" variableLength="false">KPostgreSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">KVOS</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHPUX</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: TargetParentSourceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetParentSourceId</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TaskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>Specifies the name of the Restore Task.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FileNames --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FileNames</maml:name> <maml:description> <maml:para>Specifies the full names of the files or folders to be restored.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JobId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the job id that backed up the files and will be used for this restore.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SourceId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceId</maml:name> <maml:description> <maml:para>Specifies the id of the original protection source (that was backed up) containing the files and folders.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: NewBaseDirectory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewBaseDirectory</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JobRunId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobRunId</maml:name> <maml:description> <maml:para>Specifies the Job Run id that captured the snapshot. If not specified, the latest backup run is used.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DoNotOverwrite --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotOverwrite</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ContinueOnError --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ContinueOnError</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DoNotPreserveAttributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotPreserveAttributes</maml:name> <maml:description> <maml:para>Specifies that the Restore Task should not preserve the original attributes of the files and folders. By default, the original attributes are preserved.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: TargetSourceId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetSourceId</maml:name> <maml:description> <maml:para>Specifies the id of the target source (such as a VM or Physical server) where the files and folders are to be restored.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetParentSourceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetParentSourceId</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetHostType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetHostType</maml:name> <maml:description> <maml:para>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.</maml:para> <maml:para>Possible values: KLinux, KWindows, KAix, KSolaris, KSapHana, KSapOracle, KCockroachDB, KMySQL, KOther, KSapSybase, KSapMaxDB, KSapSybaseIQ, KDB2, KSapASE, KMariaDB, KPostgreSQL, KVOS, KHPUX</maml:para> </maml:description> <command:parameterValue required="true">TargetHostTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RestoreFilesTaskRequest+TargetHostTypeEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KLinux</command:parameterValue> <command:parameterValue required="false" variableLength="false">KWindows</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAix</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSolaris</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapHana</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapOracle</command:parameterValue> <command:parameterValue required="false" variableLength="false">KCockroachDB</command:parameterValue> <command:parameterValue required="false" variableLength="false">KMySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">KOther</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapSybase</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapMaxDB</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapSybaseIQ</command:parameterValue> <command:parameterValue required="false" variableLength="false">KDB2</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapASE</command:parameterValue> <command:parameterValue required="false" variableLength="false">KMariaDB</command:parameterValue> <command:parameterValue required="false" variableLength="false">KPostgreSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">KVOS</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHPUX</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: TargetHostCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetHostCredential</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FileRecoveryMethod --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FileRecoveryMethod</maml:name> <maml:description> <maml:para>Specifies the type of method to be used to perform file recovery.</maml:para> <maml:para>Possible values: KAutoDeploy, KUseExistingAgent, KUseHypervisorAPIs</maml:para> </maml:description> <command:parameterValue required="true">FileRecoveryMethodEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RestoreFilesTaskRequest+FileRecoveryMethodEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KAutoDeploy</command:parameterValue> <command:parameterValue required="false" variableLength="false">KUseExistingAgent</command:parameterValue> <command:parameterValue required="false" variableLength="false">KUseHypervisorAPIs</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev: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)</dev:code> <dev:remarks> <maml:para>Restores the specified file to the target windows VM with the source id 856 from the latest backup.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Restore-CohesityFile -TaskName "restore-file-physical" -FileNames /C/data/file.txt -JobId 1234 -SourceId 820 -TargetSourceId 858</dev:code> <dev:remarks> <maml:para>Restores the specified file to the target physical server with the source id 858 from the latest backup.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Find-CohesityFilesForRestore --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Find-CohesityFilesForRestore</command:name> <command:verb>Find</command:verb> <command:noun>CohesityFilesForRestore</command:noun> <maml:description> <maml:para>Finds a list of files and folders for restore based on the specified parameters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If no search pattern or filter parameters are specified, all files and folders currently found on the Cohesity Cluster are returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Find-CohesityFilesForRestore</maml:name> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Environments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environments</maml:name> <maml:description> <maml:para>Filter by environment types such as kVMware, kView, kSQL, etc. Only jobs protecting the specified environment types are returned.</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionJob+EnvironmentEnum[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderOnly</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JobIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobIds</maml:name> <maml:description> <maml:para>Filter by a list of protection job ids.Only items backed up by the specified jobs are listed.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PageSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>Specifies pagesize for pagination. Only valid for librarian queries. Effective only when Paginate is set to true.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Paginate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Paginate</maml:name> <maml:description> <maml:para>Specifies bool to control pagination of search results. Only valid for librarian queries. If this is set to true and a pagination cookie is provided, search will be resumed.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PaginationCookie --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PaginationCookie</maml:name> <maml:description> <maml:para>Specifies cookie for resuming search if pagination is being used. Only valid for librarian queries. Effective only when Paginate is set to true.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RegisteredSourceIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RegisteredSourceIds</maml:name> <maml:description> <maml:para>Filter by a list of registered source ids. Only items from the listed registered sources are returned.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Search --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Search</maml:name> <maml:description> <maml:para>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".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceIds</maml:name> <maml:description> <maml:para>Filter by source ids. Only files and folders found in the listed sources (such as VMs) are returned.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageDomainIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageDomainIds</maml:name> <maml:description> <maml:para>Filter by a list of storage domain (view box) ids. Only items stored in the listed domains (view boxes) are returned.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Environments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environments</maml:name> <maml:description> <maml:para>Filter by environment types such as kVMware, kView, kSQL, etc. Only jobs protecting the specified environment types are returned.</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionJob+EnvironmentEnum[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderOnly</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Search --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Search</maml:name> <maml:description> <maml:para>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".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JobIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobIds</maml:name> <maml:description> <maml:para>Filter by a list of protection job ids.Only items backed up by the specified jobs are listed.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceIds</maml:name> <maml:description> <maml:para>Filter by source ids. Only files and folders found in the listed sources (such as VMs) are returned.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RegisteredSourceIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RegisteredSourceIds</maml:name> <maml:description> <maml:para>Filter by a list of registered source ids. Only items from the listed registered sources are returned.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Paginate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Paginate</maml:name> <maml:description> <maml:para>Specifies bool to control pagination of search results. Only valid for librarian queries. If this is set to true and a pagination cookie is provided, search will be resumed.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PageSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>Specifies pagesize for pagination. Only valid for librarian queries. Effective only when Paginate is set to true.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PaginationCookie --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PaginationCookie</maml:name> <maml:description> <maml:para>Specifies cookie for resuming search if pagination is being used. Only valid for librarian queries. Effective only when Paginate is set to true.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageDomainIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageDomainIds</maml:name> <maml:description> <maml:para>Filter by a list of storage domain (view box) ids. Only items stored in the listed domains (view boxes) are returned.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: FileSearchResult --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.FileSearchResult</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Find-CohesityFilesForRestore -Search "*txt"</dev:code> <dev:remarks> <maml:para>Returns only the files and folders that match the search pattern "txt".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Find-CohesityFilesForRestore -Search "*txt" -Paginate $true -PageSize 120</dev:code> <dev:remarks> <maml:para>Returns 120(pageSize) entries that match the search pattern "txt". Pagination Cookie in the response can be used to fetch next list of entries.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Find-CohesityFilesForRestore -Search "*txt" -Paginate $true -PaginationCookie rrrgcrsgre -PageSize 200</dev:code> <dev:remarks> <maml:para>Returns next set of entries that match the search pattern "txt" based on provided Pagiantion cookie.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Restore-CohesityHyperVVM --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Restore-CohesityHyperVVM</command:name> <command:verb>Restore</command:verb> <command:noun>CohesityHyperVVM</command:noun> <maml:description> <maml:para>Restores the specified Hyper-V virtual machine from a previous backup.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Restores the specified Hyper-V virtual machine from a previous backup.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Restore-CohesityHyperVVM</maml:name> <!-- Parameter: JobId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the job id that backed up this VM and will be used for this restore.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SourceId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceId</maml:name> <maml:description> <maml:para>Specifies the source id of the VM to be restored.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: TaskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>Specifies the name of the restore task.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisableNetwork --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableNetwork</maml:name> <maml:description> <maml:para>Specifies whether the network should be left in disabled state. Attached network is enabled by default. Use this switch to disable it.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: JobRunId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobRunId</maml:name> <maml:description> <maml:para>Specifies the job run id that captured the snapshot for this VM. If not specified the latest run is used.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PoweredOn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PoweredOn</maml:name> <maml:description> <maml:para>Specifies the power state of the recovered VM. By default, the VM is powered off.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VmNamePrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmNamePrefix</maml:name> <maml:description> <maml:para>Specifies the prefix to add to the name of the restored VM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VmNameSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmNameSuffix</maml:name> <maml:description> <maml:para>Specifies the suffix to add to the name of the restored VM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TaskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>Specifies the name of the restore task.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceId</maml:name> <maml:description> <maml:para>Specifies the source id of the VM to be restored.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: JobId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the job id that backed up this VM and will be used for this restore.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: JobRunId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobRunId</maml:name> <maml:description> <maml:para>Specifies the job run id that captured the snapshot for this VM. If not specified the latest run is used.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VmNamePrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmNamePrefix</maml:name> <maml:description> <maml:para>Specifies the prefix to add to the name of the restored VM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VmNameSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmNameSuffix</maml:name> <maml:description> <maml:para>Specifies the suffix to add to the name of the restored VM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisableNetwork --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableNetwork</maml:name> <maml:description> <maml:para>Specifies whether the network should be left in disabled state. Attached network is enabled by default. Use this switch to disable it.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PoweredOn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PoweredOn</maml:name> <maml:description> <maml:para>Specifies the power state of the recovered VM. By default, the VM is powered off.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Restore-CohesityHyperVVM -TaskName "Test-Restore" -SourceId 2 -JobId 8 -VmNamePrefix "copy-" -DisableNetwork -PoweredOn</dev:code> <dev:remarks> <maml:para>Restores the Hyper-V virtual machine with the given source id using the latest run of job id 8.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CohesityMSSQLObject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CohesityMSSQLObject</command:name> <command:verb>Get</command:verb> <command:noun>CohesityMSSQLObject</command:noun> <maml:description> <maml:para>Gets a list of the MS SQL objects known to the Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns all the MS SQL objects (databases, instances) known to the Cohesity Cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityMSSQLObject</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: ProtectionSource --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.ProtectionSource</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Get-CohesityMSSQLObject</dev:code> <dev:remarks> <maml:para>Gets a list of the MS SQL objects known to the Cohesity Cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Restore-CohesityMSSQLObject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Restore-CohesityMSSQLObject</command:name> <command:verb>Restore</command:verb> <command:noun>CohesityMSSQLObject</command:noun> <maml:description> <maml:para>Restores the specified MS SQL object from a previous backup.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Restores the specified MS SQL object from a previous backup.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Restore-CohesityMSSQLObject</maml:name> <!-- Parameter: HostSourceId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>HostSourceId</maml:name> <maml:description> <maml:para>Specifies the source id of the physical server or virtual machine that is hosting the MS SQL instance.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: JobId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the job id that backed up this MS SQL instance and will be used for this restore.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SourceId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceId</maml:name> <maml:description> <maml:para>Specifies the source id of the MS SQL database to restore. This can be obtained using Get-CohesityMSSQLObject.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: TaskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>Specifies the name of the restore task.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ArchivalId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ArchivalId</maml:name> <maml:description> <maml:para>Source of the backup object. In this case vault/archival machine. Use the cmdlet Get-CohesityVault to get the vault/archival source.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CaptureTailLogs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CaptureTailLogs</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: JobRunId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobRunId</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeepCDC --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepCDC</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: KeepOffline --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepOffline</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NewDatabaseName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDatabaseName</maml:name> <maml:description> <maml:para>Specifies a new name for the restored database.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewInstanceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewInstanceName</maml:name> <maml:description> <maml:para>Specifies the instance name of the SQL Server that should be restored.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RestoreTimeSecs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RestoreTimeSecs</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetDataFilesDirectory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetDataFilesDirectory</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetHostCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetHostCredential</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetHostId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetHostId</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetHostParentId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetHostParentId</maml:name> <maml:description> <maml:para>Specifies the id of the registered parent source (such as vCenter) of the target host.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetLogFilesDirectory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetLogFilesDirectory</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetSecondaryDataFilesDirectoryList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetSecondaryDataFilesDirectoryList</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Cohesity.Model.FilenamePatternToDirectory, Cohesity.Models, Version=6.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TaskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>Specifies the name of the restore task.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceId</maml:name> <maml:description> <maml:para>Specifies the source id of the MS SQL database to restore. This can be obtained using Get-CohesityMSSQLObject.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: HostSourceId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>HostSourceId</maml:name> <maml:description> <maml:para>Specifies the source id of the physical server or virtual machine that is hosting the MS SQL instance.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: JobId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the job id that backed up this MS SQL instance and will be used for this restore.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: JobRunId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobRunId</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CaptureTailLogs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CaptureTailLogs</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: KeepOffline --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepOffline</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: KeepCDC --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepCDC</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NewDatabaseName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewDatabaseName</maml:name> <maml:description> <maml:para>Specifies a new name for the restored database.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewInstanceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewInstanceName</maml:name> <maml:description> <maml:para>Specifies the instance name of the SQL Server that should be restored.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RestoreTimeSecs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RestoreTimeSecs</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetDataFilesDirectory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetDataFilesDirectory</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetLogFilesDirectory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetLogFilesDirectory</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetSecondaryDataFilesDirectoryList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetSecondaryDataFilesDirectoryList</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Cohesity.Model.FilenamePatternToDirectory, Cohesity.Models, Version=6.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetHostId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetHostId</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetHostParentId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetHostParentId</maml:name> <maml:description> <maml:para>Specifies the id of the registered parent source (such as vCenter) of the target host.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetHostCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetHostCredential</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ArchivalId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ArchivalId</maml:name> <maml:description> <maml:para>Source of the backup object. In this case vault/archival machine. Use the cmdlet Get-CohesityVault to get the vault/archival source.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Restore-CohesityMSSQLObject -TaskName "sql-restore-task" -SourceId 9 -HostSourceId 3 -JobId 401</dev:code> <dev:remarks> <maml:para>Restores the MS SQL DB with the given source id using the latest run of job id 401.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev: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</dev:code> <dev:remarks> <maml:para>Restores the MS SQL DB with the given source id on a target server.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev: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</dev:code> <dev:remarks> <maml:para>Request for restore MSSQL object with RestoreTimeSecs (point in time) parameter and StartTime.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Find-CohesityObjectsForRestore --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Find-CohesityObjectsForRestore</command:name> <command:verb>Find</command:verb> <command:noun>CohesityObjectsForRestore</command:noun> <maml:description> <maml:para>Finds a list of objects (VMs and Databases) for restore based on the specified parameters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If no search pattern or filter parameters are specified, all objects currently found on the Cohesity Cluster are returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Find-CohesityObjectsForRestore</maml:name> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Environments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environments</maml:name> <maml:description> <maml:para>Filter by environment types such as kVMware, kView, kSQL, etc. Only jobs protecting the specified environment types are returned.</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionJob+EnvironmentEnum[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JobIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobIds</maml:name> <maml:description> <maml:para>Filter by a list of protection job ids. Only objects backed up by the specified jobs are listed.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RegisteredSourceIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RegisteredSourceIds</maml:name> <maml:description> <maml:para>Filter by a list of registered source ids. Only objects from the listed registered sources are returned.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Search --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Search</maml:name> <maml:description> <maml:para>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".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageDomainIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageDomainIds</maml:name> <maml:description> <maml:para>Filter by a list of storage domain (view box) ids. Only objects stored in the listed domains (view boxes) are returned.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Environments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environments</maml:name> <maml:description> <maml:para>Filter by environment types such as kVMware, kView, kSQL, etc. Only jobs protecting the specified environment types are returned.</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionJob+EnvironmentEnum[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Search --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Search</maml:name> <maml:description> <maml:para>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".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JobIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobIds</maml:name> <maml:description> <maml:para>Filter by a list of protection job ids. Only objects backed up by the specified jobs are listed.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RegisteredSourceIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RegisteredSourceIds</maml:name> <maml:description> <maml:para>Filter by a list of registered source ids. Only objects from the listed registered sources are returned.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageDomainIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageDomainIds</maml:name> <maml:description> <maml:para>Filter by a list of storage domain (view box) ids. Only objects stored in the listed domains (view boxes) are returned.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ObjectSnapshotInfo --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.ObjectSnapshotInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Find-CohesityObjectsForRestore -Search "linux"</dev:code> <dev:remarks> <maml:para>Returns only the objects that match the search pattern "linux".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CohesityPhysicalAgent --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CohesityPhysicalAgent</command:name> <command:verb>Get</command:verb> <command:noun>CohesityPhysicalAgent</command:noun> <maml:description> <maml:para>Gets a list of the registered physical agents with their information.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a list of the registered physical agents with their information.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityPhysicalAgent</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: AgentInformation --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.AgentInformation</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Get-CohesityPhysicalAgent</dev:code> <dev:remarks> <maml:para>Gets a list of the registered physical agents with their information.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-CohesityPhysicalAgent --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Update-CohesityPhysicalAgent</command:name> <command:verb>Update</command:verb> <command:noun>CohesityPhysicalAgent</command:noun> <maml:description> <maml:para>Upgrades the Cohesity agent on a Physical server registered with Cohesity.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Upgrades the Cohesity agent on a Physical server registered with Cohesity.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-CohesityPhysicalAgent</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies a unique id of the physical agent.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies a unique id of the physical agent.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies a unique id of the physical agent.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Update-CohesityPhysicalAgent -Id 12</dev:code> <dev:remarks> <maml:para>Upgrades the physical agent with the specified Id.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CohesityPrivilege --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CohesityPrivilege</command:name> <command:verb>Get</command:verb> <command:noun>CohesityPrivilege</command:noun> <maml:description> <maml:para>Gets all privileges defined on the Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>In addition, information about each privilege is returned such as the associated category, description, name.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityPrivilege</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Privilege.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Privilege.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: PrivilegeInfo --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.PrivilegeInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Get-CohesityPrivilege -Name PRINCIPAL_VIEW</dev:code> <dev:remarks> <maml:para>Gets details of privilege with name PRINCIPAL_VIEW.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Disable-CohesityProtectionJob --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-CohesityProtectionJob</command:name> <command:verb>Disable</command:verb> <command:noun>CohesityProtectionJob</command:noun> <maml:description> <maml:para>Deactivates the specified protection job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deactivates the specified protection job. This is used for failover to a remote cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Disable-CohesityProtectionJob</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique id of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: PowerOffVms --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PowerOffVms</maml:name> <maml:description> <maml:para>Specifies whether to power off the VMs in VMware environment.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Disable-CohesityProtectionJob</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PowerOffVms --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PowerOffVms</maml:name> <maml:description> <maml:para>Specifies whether to power off the VMs in VMware environment.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique id of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PowerOffVms --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PowerOffVms</maml:name> <maml:description> <maml:para>Specifies whether to power off the VMs in VMware environment.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the unique id of the protection job.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Disable-CohesityProtectionJob -Id 1234</dev:code> <dev:remarks> <maml:para>Deactivates the protection job with the Id of 1234.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Disable-CohesityProtectionJob -Name "vm-replication-job" -PowerOffVms</dev:code> <dev:remarks> <maml:para>Deactivates the protection job with the name "vm-replication-job" and also powers off the associated VMs in VMware environment.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Enable-CohesityProtectionJob --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-CohesityProtectionJob</command:name> <command:verb>Enable</command:verb> <command:noun>CohesityProtectionJob</command:noun> <maml:description> <maml:para>Activates the specified protection job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Activates the specified protection job. This is used for failback scenario on remote cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Enable-CohesityProtectionJob</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique id of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ParentSourceId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ParentSourceId</maml:name> <maml:description> <maml:para>Specifies the unique id of the parent protection source (eg. a vCenter server) protected by this protection job.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PolicyId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>Specifies the unique id of the protection policy to be associated with the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Enable-CohesityProtectionJob</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ParentSourceId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ParentSourceId</maml:name> <maml:description> <maml:para>Specifies the unique id of the parent protection source (eg. a vCenter server) protected by this protection job.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PolicyId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>Specifies the unique id of the protection policy to be associated with the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique id of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PolicyId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>Specifies the unique id of the protection policy to be associated with the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ParentSourceId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ParentSourceId</maml:name> <maml:description> <maml:para>Specifies the unique id of the parent protection source (eg. a vCenter server) protected by this protection job.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the unique id of the protection job.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Enable-CohesityProtectionJob -Id 1234 -PolicyId "437211583895198:1541716981258:3" -ParentSourceId 13</dev:code> <dev:remarks> <maml:para>Activates a protection job with the id of 1234 and associates it with the specified policy id and source id.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-CohesityProtectionJob --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-CohesityProtectionJob</command:name> <command:verb>New</command:verb> <command:noun>CohesityProtectionJob</command:noun> <maml:description> <maml:para>Creates a new protection job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the created protection job.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: CreateById --> <command:syntaxItem> <maml:name>New-CohesityProtectionJob</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PolicyId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>Specifies the unique id of the protection policy associated with the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageDomainId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageDomainId</maml:name> <maml:description> <maml:para>Specifies the storage domain (view box) id where this job writes data.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: AlertOn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AlertOn</maml:name> <maml:description> <maml:para>Array of Job Events. During Job Runs, the following Job Events are generated: 1) Job succeeds 2) Job fails 3) Job violates the SLA These Job Events can cause Alerts to be generated. 'kSuccess' means the Protection Job succeeded. 'kFailure' means the Protection Job failed. 'kSlaViolation' means the Protection Job took longer than the time period specified in the SLA. Default is kFailure.</maml:para> </maml:description> <command:parameterValue required="true">AlertingPolicyEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionJob+AlertingPolicyEnum[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EmailAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>Specifies additional email addresses where alert notifications (configured in the AlertingPolicy) must be sent.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EnableIndexing --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableIndexing</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EndTimeUsecs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTimeUsecs</maml:name> <maml:description> <maml:para>Specifies the epoch time (in microseconds) after which the Protection Job becomes dormant.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Environment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Specifies the environment that this job is protecting. Default is kView.</maml:para> <maml:para>Possible values: KVMware, KHyperV, KSQL, KView, KPuppeteer, KPhysical, KPure, KNimble, KAzure, KNetapp, KAgent, KGenericNas, KAcropolis, KPhysicalFiles, KIsilon, KGPFS, KKVM, KAWS, KExchange, KHyperVVSS, KOracle, KGCP, KFlashBlade, KAWSNative, KO365, KO365Outlook, KHyperFlex, KGCPNative, KAzureNative, KKubernetes, KElastifile, KAD, KRDSSnapshotManager, KCassandra, KMongoDB, KCouchbase, KHdfs, KHive, KHBase, KUDA, KO365Teams, KO365Group, KO365Exchange, KO365OneDrive, KO365Sharepoint, KO365PublicFolders</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionJob+EnvironmentEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KVMware</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHyperV</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">KView</command:parameterValue> <command:parameterValue required="false" variableLength="false">KPuppeteer</command:parameterValue> <command:parameterValue required="false" variableLength="false">KPhysical</command:parameterValue> <command:parameterValue required="false" variableLength="false">KPure</command:parameterValue> <command:parameterValue required="false" variableLength="false">KNimble</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAzure</command:parameterValue> <command:parameterValue required="false" variableLength="false">KNetapp</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAgent</command:parameterValue> <command:parameterValue required="false" variableLength="false">KGenericNas</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAcropolis</command:parameterValue> <command:parameterValue required="false" variableLength="false">KPhysicalFiles</command:parameterValue> <command:parameterValue required="false" variableLength="false">KIsilon</command:parameterValue> <command:parameterValue required="false" variableLength="false">KGPFS</command:parameterValue> <command:parameterValue required="false" variableLength="false">KKVM</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAWS</command:parameterValue> <command:parameterValue required="false" variableLength="false">KExchange</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHyperVVSS</command:parameterValue> <command:parameterValue required="false" variableLength="false">KOracle</command:parameterValue> <command:parameterValue required="false" variableLength="false">KGCP</command:parameterValue> <command:parameterValue required="false" variableLength="false">KFlashBlade</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAWSNative</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365Outlook</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHyperFlex</command:parameterValue> <command:parameterValue required="false" variableLength="false">KGCPNative</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAzureNative</command:parameterValue> <command:parameterValue required="false" variableLength="false">KKubernetes</command:parameterValue> <command:parameterValue required="false" variableLength="false">KElastifile</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">KRDSSnapshotManager</command:parameterValue> <command:parameterValue required="false" variableLength="false">KCassandra</command:parameterValue> <command:parameterValue required="false" variableLength="false">KMongoDB</command:parameterValue> <command:parameterValue required="false" variableLength="false">KCouchbase</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHdfs</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHive</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHBase</command:parameterValue> <command:parameterValue required="false" variableLength="false">KUDA</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365Teams</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365Group</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365Exchange</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365OneDrive</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365Sharepoint</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365PublicFolders</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ExcludeSourceIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeSourceIds</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeVmTagIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeVmTagIds</maml:name> <maml:description> <maml:para>Specifies a list of VM tag ids to exclude VMs with the corresponding tags.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FullSLATimeInMinutes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FullSLATimeInMinutes</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncrementalSLATimeInMinutes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncrementalSLATimeInMinutes</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ParentSourceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ParentSourceId</maml:name> <maml:description> <maml:para>Specifies the unique id of the parent protection source (such as a vCenter server) protected by this protection job.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PauseFutureRuns --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PauseFutureRuns</maml:name> <maml:description> <maml:para>Specifies if the Protection Job is paused, which means that no new Job Runs are started but any existing Job Runs continue to execute.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the priority of execution for a Protection Job. Cohesity supports concurrent backups but if the number of Jobs exceeds the ability to process Jobs, the specified priority determines the execution Job priority. This field also specifies the replication priority. 'kLow' indicates lowest execution priority for a Protection job. 'kMedium' indicates medium execution priority for a Protection job. 'kHigh' indicates highest execution priority for a Protection job. Default is kMedium.</maml:para> <maml:para>Possible values: KLow, KMedium, KHigh</maml:para> </maml:description> <command:parameterValue required="true">PriorityEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionJob+PriorityEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KLow</command:parameterValue> <command:parameterValue required="false" variableLength="false">KMedium</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHigh</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: QosType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QosType</maml:name> <maml:description> <maml:para>Specifies the QoS policy type to use for this Protection Job. 'kBackupHDD' indicates the Cohesity Cluster writes data directly to the HDD tier for this Protection Job. This is the recommended setting. 'kBackupSSD' indicates the Cohesity Cluster writes data directly to the SSD tier for this Protection Job. Only specify this policy if you need fast ingest speed for a small number of Protection Jobs. 'kTestAndDevHigh' indicated the test and dev workload. 'kBackupAll' indicates the Cohesity Cluster writes data directly to the HDD tier and the SSD tier for this Protection Job. Default is kBackupHDD.</maml:para> <maml:para>Possible values: KBackupHDD, KBackupSSD, KTestAndDevHigh, KBackupAll</maml:para> </maml:description> <command:parameterValue required="true">QosTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionJob+QosTypeEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KBackupHDD</command:parameterValue> <command:parameterValue required="false" variableLength="false">KBackupSSD</command:parameterValue> <command:parameterValue required="false" variableLength="false">KTestAndDevHigh</command:parameterValue> <command:parameterValue required="false" variableLength="false">KBackupAll</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ScheduleStartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ScheduleStartTime</maml:name> <maml:description> <maml:para>Specifies the start date time for this protection job.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/27/2024 8:58:01 PM</dev:defaultValue> </command:parameter> <!-- Parameter: SourceIds --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>SourceIds</maml:name> <maml:description> <maml:para>Specifies the unique id of the protection source objects (such as a virtual machines) protected by this protection job.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceSpecialParameters --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceSpecialParameters</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SourceSpecialParameter[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.SourceSpecialParameter[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timezone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timezone</maml:name> <maml:description> <maml:para>Specifies the timezone for this protection job. Must be a string in Olson time zone format such as "America/Los_Angeles".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ViewName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ViewName</maml:name> <maml:description> <maml:para>Specifies the name of the View associated with the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VmTagIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmTagIds</maml:name> <maml:description> <maml:para>Specifies a list of VM tag ids to protect VMs with the corresponding tags.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: CreateByName --> <command:syntaxItem> <maml:name>New-CohesityProtectionJob</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PolicyName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PolicyName</maml:name> <maml:description> <maml:para>Specifies the name of the protection policy associated with the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageDomainName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageDomainName</maml:name> <maml:description> <maml:para>Specifies the name of the storage domain associated with the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AlertOn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AlertOn</maml:name> <maml:description> <maml:para>Array of Job Events. During Job Runs, the following Job Events are generated: 1) Job succeeds 2) Job fails 3) Job violates the SLA These Job Events can cause Alerts to be generated. 'kSuccess' means the Protection Job succeeded. 'kFailure' means the Protection Job failed. 'kSlaViolation' means the Protection Job took longer than the time period specified in the SLA. Default is kFailure.</maml:para> </maml:description> <command:parameterValue required="true">AlertingPolicyEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionJob+AlertingPolicyEnum[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EmailAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>Specifies additional email addresses where alert notifications (configured in the AlertingPolicy) must be sent.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EnableIndexing --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableIndexing</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EndTimeUsecs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTimeUsecs</maml:name> <maml:description> <maml:para>Specifies the epoch time (in microseconds) after which the Protection Job becomes dormant.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Environment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Specifies the environment that this job is protecting. Default is kView.</maml:para> <maml:para>Possible values: KVMware, KHyperV, KSQL, KView, KPuppeteer, KPhysical, KPure, KNimble, KAzure, KNetapp, KAgent, KGenericNas, KAcropolis, KPhysicalFiles, KIsilon, KGPFS, KKVM, KAWS, KExchange, KHyperVVSS, KOracle, KGCP, KFlashBlade, KAWSNative, KO365, KO365Outlook, KHyperFlex, KGCPNative, KAzureNative, KKubernetes, KElastifile, KAD, KRDSSnapshotManager, KCassandra, KMongoDB, KCouchbase, KHdfs, KHive, KHBase, KUDA, KO365Teams, KO365Group, KO365Exchange, KO365OneDrive, KO365Sharepoint, KO365PublicFolders</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionJob+EnvironmentEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KVMware</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHyperV</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">KView</command:parameterValue> <command:parameterValue required="false" variableLength="false">KPuppeteer</command:parameterValue> <command:parameterValue required="false" variableLength="false">KPhysical</command:parameterValue> <command:parameterValue required="false" variableLength="false">KPure</command:parameterValue> <command:parameterValue required="false" variableLength="false">KNimble</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAzure</command:parameterValue> <command:parameterValue required="false" variableLength="false">KNetapp</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAgent</command:parameterValue> <command:parameterValue required="false" variableLength="false">KGenericNas</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAcropolis</command:parameterValue> <command:parameterValue required="false" variableLength="false">KPhysicalFiles</command:parameterValue> <command:parameterValue required="false" variableLength="false">KIsilon</command:parameterValue> <command:parameterValue required="false" variableLength="false">KGPFS</command:parameterValue> <command:parameterValue required="false" variableLength="false">KKVM</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAWS</command:parameterValue> <command:parameterValue required="false" variableLength="false">KExchange</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHyperVVSS</command:parameterValue> <command:parameterValue required="false" variableLength="false">KOracle</command:parameterValue> <command:parameterValue required="false" variableLength="false">KGCP</command:parameterValue> <command:parameterValue required="false" variableLength="false">KFlashBlade</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAWSNative</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365Outlook</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHyperFlex</command:parameterValue> <command:parameterValue required="false" variableLength="false">KGCPNative</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAzureNative</command:parameterValue> <command:parameterValue required="false" variableLength="false">KKubernetes</command:parameterValue> <command:parameterValue required="false" variableLength="false">KElastifile</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">KRDSSnapshotManager</command:parameterValue> <command:parameterValue required="false" variableLength="false">KCassandra</command:parameterValue> <command:parameterValue required="false" variableLength="false">KMongoDB</command:parameterValue> <command:parameterValue required="false" variableLength="false">KCouchbase</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHdfs</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHive</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHBase</command:parameterValue> <command:parameterValue required="false" variableLength="false">KUDA</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365Teams</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365Group</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365Exchange</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365OneDrive</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365Sharepoint</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365PublicFolders</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ExcludeSourceIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeSourceIds</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeVmTagIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeVmTagIds</maml:name> <maml:description> <maml:para>Specifies a list of VM tag ids to exclude VMs with the corresponding tags.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FullSLATimeInMinutes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FullSLATimeInMinutes</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncrementalSLATimeInMinutes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncrementalSLATimeInMinutes</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ParentSourceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ParentSourceId</maml:name> <maml:description> <maml:para>Specifies the unique id of the parent protection source (such as a vCenter server) protected by this protection job.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PauseFutureRuns --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PauseFutureRuns</maml:name> <maml:description> <maml:para>Specifies if the Protection Job is paused, which means that no new Job Runs are started but any existing Job Runs continue to execute.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the priority of execution for a Protection Job. Cohesity supports concurrent backups but if the number of Jobs exceeds the ability to process Jobs, the specified priority determines the execution Job priority. This field also specifies the replication priority. 'kLow' indicates lowest execution priority for a Protection job. 'kMedium' indicates medium execution priority for a Protection job. 'kHigh' indicates highest execution priority for a Protection job. Default is kMedium.</maml:para> <maml:para>Possible values: KLow, KMedium, KHigh</maml:para> </maml:description> <command:parameterValue required="true">PriorityEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionJob+PriorityEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KLow</command:parameterValue> <command:parameterValue required="false" variableLength="false">KMedium</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHigh</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: QosType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QosType</maml:name> <maml:description> <maml:para>Specifies the QoS policy type to use for this Protection Job. 'kBackupHDD' indicates the Cohesity Cluster writes data directly to the HDD tier for this Protection Job. This is the recommended setting. 'kBackupSSD' indicates the Cohesity Cluster writes data directly to the SSD tier for this Protection Job. Only specify this policy if you need fast ingest speed for a small number of Protection Jobs. 'kTestAndDevHigh' indicated the test and dev workload. 'kBackupAll' indicates the Cohesity Cluster writes data directly to the HDD tier and the SSD tier for this Protection Job. Default is kBackupHDD.</maml:para> <maml:para>Possible values: KBackupHDD, KBackupSSD, KTestAndDevHigh, KBackupAll</maml:para> </maml:description> <command:parameterValue required="true">QosTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionJob+QosTypeEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KBackupHDD</command:parameterValue> <command:parameterValue required="false" variableLength="false">KBackupSSD</command:parameterValue> <command:parameterValue required="false" variableLength="false">KTestAndDevHigh</command:parameterValue> <command:parameterValue required="false" variableLength="false">KBackupAll</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ScheduleStartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ScheduleStartTime</maml:name> <maml:description> <maml:para>Specifies the start date time for this protection job.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/27/2024 8:58:01 PM</dev:defaultValue> </command:parameter> <!-- Parameter: SourceIds --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>SourceIds</maml:name> <maml:description> <maml:para>Specifies the unique id of the protection source objects (such as a virtual machines) protected by this protection job.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceSpecialParameters --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceSpecialParameters</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SourceSpecialParameter[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.SourceSpecialParameter[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timezone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timezone</maml:name> <maml:description> <maml:para>Specifies the timezone for this protection job. Must be a string in Olson time zone format such as "America/Los_Angeles".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ViewName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ViewName</maml:name> <maml:description> <maml:para>Specifies the name of the View associated with the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VmTagIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmTagIds</maml:name> <maml:description> <maml:para>Specifies a list of VM tag ids to protect VMs with the corresponding tags.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PolicyId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>Specifies the unique id of the protection policy associated with the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PolicyName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PolicyName</maml:name> <maml:description> <maml:para>Specifies the name of the protection policy associated with the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ParentSourceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ParentSourceId</maml:name> <maml:description> <maml:para>Specifies the unique id of the parent protection source (such as a vCenter server) protected by this protection job.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceIds --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>SourceIds</maml:name> <maml:description> <maml:para>Specifies the unique id of the protection source objects (such as a virtual machines) protected by this protection job.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeSourceIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeSourceIds</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VmTagIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmTagIds</maml:name> <maml:description> <maml:para>Specifies a list of VM tag ids to protect VMs with the corresponding tags.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeVmTagIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeVmTagIds</maml:name> <maml:description> <maml:para>Specifies a list of VM tag ids to exclude VMs with the corresponding tags.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timezone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timezone</maml:name> <maml:description> <maml:para>Specifies the timezone for this protection job. Must be a string in Olson time zone format such as "America/Los_Angeles".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ScheduleStartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ScheduleStartTime</maml:name> <maml:description> <maml:para>Specifies the start date time for this protection job.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/27/2024 8:58:01 PM</dev:defaultValue> </command:parameter> <!-- Parameter: StorageDomainId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageDomainId</maml:name> <maml:description> <maml:para>Specifies the storage domain (view box) id where this job writes data.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: StorageDomainName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageDomainName</maml:name> <maml:description> <maml:para>Specifies the name of the storage domain associated with the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ViewName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ViewName</maml:name> <maml:description> <maml:para>Specifies the name of the View associated with the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FullSLATimeInMinutes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FullSLATimeInMinutes</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncrementalSLATimeInMinutes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncrementalSLATimeInMinutes</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Environment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Specifies the environment that this job is protecting. Default is kView.</maml:para> <maml:para>Possible values: KVMware, KHyperV, KSQL, KView, KPuppeteer, KPhysical, KPure, KNimble, KAzure, KNetapp, KAgent, KGenericNas, KAcropolis, KPhysicalFiles, KIsilon, KGPFS, KKVM, KAWS, KExchange, KHyperVVSS, KOracle, KGCP, KFlashBlade, KAWSNative, KO365, KO365Outlook, KHyperFlex, KGCPNative, KAzureNative, KKubernetes, KElastifile, KAD, KRDSSnapshotManager, KCassandra, KMongoDB, KCouchbase, KHdfs, KHive, KHBase, KUDA, KO365Teams, KO365Group, KO365Exchange, KO365OneDrive, KO365Sharepoint, KO365PublicFolders</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionJob+EnvironmentEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KVMware</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHyperV</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">KView</command:parameterValue> <command:parameterValue required="false" variableLength="false">KPuppeteer</command:parameterValue> <command:parameterValue required="false" variableLength="false">KPhysical</command:parameterValue> <command:parameterValue required="false" variableLength="false">KPure</command:parameterValue> <command:parameterValue required="false" variableLength="false">KNimble</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAzure</command:parameterValue> <command:parameterValue required="false" variableLength="false">KNetapp</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAgent</command:parameterValue> <command:parameterValue required="false" variableLength="false">KGenericNas</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAcropolis</command:parameterValue> <command:parameterValue required="false" variableLength="false">KPhysicalFiles</command:parameterValue> <command:parameterValue required="false" variableLength="false">KIsilon</command:parameterValue> <command:parameterValue required="false" variableLength="false">KGPFS</command:parameterValue> <command:parameterValue required="false" variableLength="false">KKVM</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAWS</command:parameterValue> <command:parameterValue required="false" variableLength="false">KExchange</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHyperVVSS</command:parameterValue> <command:parameterValue required="false" variableLength="false">KOracle</command:parameterValue> <command:parameterValue required="false" variableLength="false">KGCP</command:parameterValue> <command:parameterValue required="false" variableLength="false">KFlashBlade</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAWSNative</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365Outlook</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHyperFlex</command:parameterValue> <command:parameterValue required="false" variableLength="false">KGCPNative</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAzureNative</command:parameterValue> <command:parameterValue required="false" variableLength="false">KKubernetes</command:parameterValue> <command:parameterValue required="false" variableLength="false">KElastifile</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">KRDSSnapshotManager</command:parameterValue> <command:parameterValue required="false" variableLength="false">KCassandra</command:parameterValue> <command:parameterValue required="false" variableLength="false">KMongoDB</command:parameterValue> <command:parameterValue required="false" variableLength="false">KCouchbase</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHdfs</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHive</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHBase</command:parameterValue> <command:parameterValue required="false" variableLength="false">KUDA</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365Teams</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365Group</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365Exchange</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365OneDrive</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365Sharepoint</command:parameterValue> <command:parameterValue required="false" variableLength="false">KO365PublicFolders</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: SourceSpecialParameters --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceSpecialParameters</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SourceSpecialParameter[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.SourceSpecialParameter[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EnableIndexing --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableIndexing</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PauseFutureRuns --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PauseFutureRuns</maml:name> <maml:description> <maml:para>Specifies if the Protection Job is paused, which means that no new Job Runs are started but any existing Job Runs continue to execute.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EndTimeUsecs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTimeUsecs</maml:name> <maml:description> <maml:para>Specifies the epoch time (in microseconds) after which the Protection Job becomes dormant.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QosType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QosType</maml:name> <maml:description> <maml:para>Specifies the QoS policy type to use for this Protection Job. 'kBackupHDD' indicates the Cohesity Cluster writes data directly to the HDD tier for this Protection Job. This is the recommended setting. 'kBackupSSD' indicates the Cohesity Cluster writes data directly to the SSD tier for this Protection Job. Only specify this policy if you need fast ingest speed for a small number of Protection Jobs. 'kTestAndDevHigh' indicated the test and dev workload. 'kBackupAll' indicates the Cohesity Cluster writes data directly to the HDD tier and the SSD tier for this Protection Job. Default is kBackupHDD.</maml:para> <maml:para>Possible values: KBackupHDD, KBackupSSD, KTestAndDevHigh, KBackupAll</maml:para> </maml:description> <command:parameterValue required="true">QosTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionJob+QosTypeEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KBackupHDD</command:parameterValue> <command:parameterValue required="false" variableLength="false">KBackupSSD</command:parameterValue> <command:parameterValue required="false" variableLength="false">KTestAndDevHigh</command:parameterValue> <command:parameterValue required="false" variableLength="false">KBackupAll</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the priority of execution for a Protection Job. Cohesity supports concurrent backups but if the number of Jobs exceeds the ability to process Jobs, the specified priority determines the execution Job priority. This field also specifies the replication priority. 'kLow' indicates lowest execution priority for a Protection job. 'kMedium' indicates medium execution priority for a Protection job. 'kHigh' indicates highest execution priority for a Protection job. Default is kMedium.</maml:para> <maml:para>Possible values: KLow, KMedium, KHigh</maml:para> </maml:description> <command:parameterValue required="true">PriorityEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionJob+PriorityEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KLow</command:parameterValue> <command:parameterValue required="false" variableLength="false">KMedium</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHigh</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: AlertOn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AlertOn</maml:name> <maml:description> <maml:para>Array of Job Events. During Job Runs, the following Job Events are generated: 1) Job succeeds 2) Job fails 3) Job violates the SLA These Job Events can cause Alerts to be generated. 'kSuccess' means the Protection Job succeeded. 'kFailure' means the Protection Job failed. 'kSlaViolation' means the Protection Job took longer than the time period specified in the SLA. Default is kFailure.</maml:para> </maml:description> <command:parameterValue required="true">AlertingPolicyEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionJob+AlertingPolicyEnum[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EmailAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>Specifies additional email addresses where alert notifications (configured in the AlertingPolicy) must be sent.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the unique id of the protection source objects (such as a virtual machines) protected by this protection job.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ProtectionJob --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.ProtectionJob</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>New-CohesityProtectionJob -Name 'Test-Job-View' -Description 'Protects a View' -PolicyId 4816026365909361:1530076822448:1 -Environment kView -ViewName cohesity_int_19417 -StorageDomainId 3144</dev:code> <dev:remarks> <maml:para>Creates a protection job for protecting a Cohesity View.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CohesityProtectionJob --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CohesityProtectionJob</command:name> <command:verb>Remove</command:verb> <command:noun>CohesityProtectionJob</command:noun> <maml:description> <maml:para>Removes a protection job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns success if the protection job is deleted.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Remove-CohesityProtectionJob</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique id of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: KeepSnapshots --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSnapshots</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-CohesityProtectionJob</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeepSnapshots --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSnapshots</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique id of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeepSnapshots --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSnapshots</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the unique id of the protection job.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Remove-CohesityProtectionJob -Id 1234</dev:code> <dev:remarks> <maml:para>Removes a protection job with the Id of 1234 and all snapshots generated by the protection job.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Remove-CohesityProtectionJob -Id 1234 -KeepSnapshots</dev:code> <dev:remarks> <maml:para>Removes a protection job with the Id of 1234, snapshots generated by the protection job are not deleted.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Resume-CohesityProtectionJob --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Resume-CohesityProtectionJob</command:name> <command:verb>Resume</command:verb> <command:noun>CohesityProtectionJob</command:noun> <maml:description> <maml:para>Resumes the future runs of the specified protection job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Resume-CohesityProtectionJob</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique id of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Resume-CohesityProtectionJob</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique id of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the unique id of the protection job.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Resume-CohesityProtectionJob -Id 1234</dev:code> <dev:remarks> <maml:para>Resumes a protection job with the Id of 1234.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-CohesityProtectionJob --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-CohesityProtectionJob</command:name> <command:verb>Start</command:verb> <command:noun>CohesityProtectionJob</command:noun> <maml:description> <maml:para>Immediately starts a protection job run.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Start-CohesityProtectionJob</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies a unique id of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: CopyRunTargets --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CopyRunTargets</maml:name> <maml:description> <maml:para>Set if you want specific replication or archival associated with the policy to run.</maml:para> </maml:description> <command:parameterValue required="true">RunJobSnapshotTarget[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RunJobSnapshotTarget[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RunType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunType</maml:name> <maml:description> <maml:para>Specifies the type of backup. If not specified, "KRegular" is assumed.</maml:para> <maml:para>Possible values: KRegular, KFull, KLog, KSystem</maml:para> </maml:description> <command:parameterValue required="true">RunTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RunProtectionJobParam+RunTypeEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>KRegular</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KRegular</command:parameterValue> <command:parameterValue required="false" variableLength="false">KFull</command:parameterValue> <command:parameterValue required="false" variableLength="false">KLog</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSystem</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: SourceIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceIds</maml:name> <maml:description> <maml:para>If you want to back up only a subset of sources that are protected by the job in this run.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Start-CohesityProtectionJob</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CopyRunTargets --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CopyRunTargets</maml:name> <maml:description> <maml:para>Set if you want specific replication or archival associated with the policy to run.</maml:para> </maml:description> <command:parameterValue required="true">RunJobSnapshotTarget[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RunJobSnapshotTarget[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RunType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunType</maml:name> <maml:description> <maml:para>Specifies the type of backup. If not specified, "KRegular" is assumed.</maml:para> <maml:para>Possible values: KRegular, KFull, KLog, KSystem</maml:para> </maml:description> <command:parameterValue required="true">RunTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RunProtectionJobParam+RunTypeEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>KRegular</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KRegular</command:parameterValue> <command:parameterValue required="false" variableLength="false">KFull</command:parameterValue> <command:parameterValue required="false" variableLength="false">KLog</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSystem</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: SourceIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceIds</maml:name> <maml:description> <maml:para>If you want to back up only a subset of sources that are protected by the job in this run.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies a unique id of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RunType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunType</maml:name> <maml:description> <maml:para>Specifies the type of backup. If not specified, "KRegular" is assumed.</maml:para> <maml:para>Possible values: KRegular, KFull, KLog, KSystem</maml:para> </maml:description> <command:parameterValue required="true">RunTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RunProtectionJobParam+RunTypeEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>KRegular</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KRegular</command:parameterValue> <command:parameterValue required="false" variableLength="false">KFull</command:parameterValue> <command:parameterValue required="false" variableLength="false">KLog</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSystem</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: SourceIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceIds</maml:name> <maml:description> <maml:para>If you want to back up only a subset of sources that are protected by the job in this run.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CopyRunTargets --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CopyRunTargets</maml:name> <maml:description> <maml:para>Set if you want specific replication or archival associated with the policy to run.</maml:para> </maml:description> <command:parameterValue required="true">RunJobSnapshotTarget[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RunJobSnapshotTarget[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies a unique id of the protection job.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Start-CohesityProtectionJob -Id 1234</dev:code> <dev:remarks> <maml:para>Immediately starts a job run for the given protection job.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Suspend-CohesityProtectionJob --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Suspend-CohesityProtectionJob</command:name> <command:verb>Suspend</command:verb> <command:noun>CohesityProtectionJob</command:noun> <maml:description> <maml:para>Pauses the future runs of the specified protection job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Suspend-CohesityProtectionJob</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique id of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Suspend-CohesityProtectionJob</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique id of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the protection job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the unique id of the protection job.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Suspend-CohesityProtectionJob -Id 1234</dev:code> <dev:remarks> <maml:para>Pauses a protection job with the Id of 1234.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CohesityProtectionPolicy --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CohesityProtectionPolicy</command:name> <command:verb>Remove</command:verb> <command:noun>CohesityProtectionPolicy</command:noun> <maml:description> <maml:para>Removes a protection policy.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns success if the protection policy is removed.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-CohesityProtectionPolicy</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique id of the protection policy.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the unique id of the protection policy.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the unique id of the protection policy.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Remove-CohesityProtectionPolicy -Id 7004504288922732:1533243443420:3</dev:code> <dev:remarks> <maml:para>Removes a protection policy with the specified Id.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Unregister-CohesityProtectionSource --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Unregister-CohesityProtectionSource</command:name> <command:verb>Unregister</command:verb> <command:noun>CohesityProtectionSource</command:noun> <maml:description> <maml:para>Unregisters the specified protection source from the Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Unregisters the specified protection source from the Cohesity Cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Unregister-CohesityProtectionSource</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies a unique id of the protection source.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Unregister-CohesityProtectionSource</maml:name> <!-- Parameter: ProtectionSource --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ProtectionSource</maml:name> <maml:description> <maml:para>Specifies a protection source object.</maml:para> </maml:description> <command:parameterValue required="true">ProtectionSourceNode</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionSourceNode</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies a unique id of the protection source.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ProtectionSource --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ProtectionSource</maml:name> <maml:description> <maml:para>Specifies a protection source object.</maml:para> </maml:description> <command:parameterValue required="true">ProtectionSourceNode</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionSourceNode</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies a unique id of the protection source.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Cohesity.Model.ProtectionSourceNode</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies a protection source object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Unregister-CohesityProtectionSource -Id 12</dev:code> <dev:remarks> <maml:para>Unregisters the given protection source.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-CohesityProtectionSource --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Update-CohesityProtectionSource</command:name> <command:verb>Update</command:verb> <command:noun>CohesityProtectionSource</command:noun> <maml:description> <maml:para>Refreshes the object hierarchy of the specified protection source on the Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Update-CohesityProtectionSource</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies a unique id of the protection source.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Update-CohesityProtectionSource</maml:name> <!-- Parameter: ProtectionSource --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ProtectionSource</maml:name> <maml:description> <maml:para>Specifies a protection source object.</maml:para> </maml:description> <command:parameterValue required="true">ProtectionSourceNode</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionSourceNode</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies a unique id of the protection source.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ProtectionSource --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ProtectionSource</maml:name> <maml:description> <maml:para>Specifies a protection source object.</maml:para> </maml:description> <command:parameterValue required="true">ProtectionSourceNode</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionSourceNode</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies a unique id of the protection source.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Cohesity.Model.ProtectionSourceNode</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies a protection source object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Update-CohesityProtectionSource -Id 12</dev:code> <dev:remarks> <maml:para>Immediately refreshes the given protection source.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Register-CohesityProtectionSourceAcropolis --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Register-CohesityProtectionSourceAcropolis</command:name> <command:verb>Register</command:verb> <command:noun>CohesityProtectionSourceAcropolis</command:noun> <maml:description> <maml:para>Registers a new Nutanix Acropolis protection source with the Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Registers a new Nutanix Acropolis protection source with the Cohesity Cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Register-CohesityProtectionSourceAcropolis</maml:name> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>User credentials for the Acropolis cluster.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Hostname or IP Address for the Acropolis cluster.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EntityType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityType</maml:name> <maml:description> <maml:para>Specifies entity type for acropolis. Recommend to use the default value 'KStandaloneCluster'.</maml:para> <maml:para>Possible values: KStandaloneCluster</maml:para> </maml:description> <command:parameterValue required="true">AcropolisTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RegisterProtectionSourceParameters+AcropolisTypeEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>KStandaloneCluster</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KStandaloneCluster</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Hostname or IP Address for the Acropolis cluster.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>User credentials for the Acropolis cluster.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EntityType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityType</maml:name> <maml:description> <maml:para>Specifies entity type for acropolis. Recommend to use the default value 'KStandaloneCluster'.</maml:para> <maml:para>Possible values: KStandaloneCluster</maml:para> </maml:description> <command:parameterValue required="true">AcropolisTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RegisterProtectionSourceParameters+AcropolisTypeEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>KStandaloneCluster</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KStandaloneCluster</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ProtectionSource --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.ProtectionSource</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Register-CohesityProtectionSourceAcropolis -Server nutanix-ahv.example.com -Credential (Get-Credential)</dev:code> <dev:remarks> <maml:para>Registers a new Nutanix Acropolis cluster with hostname "nutanix-ahv.example.com" with the Cohesity Cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Register-CohesityProtectionSourceMSSQL --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Register-CohesityProtectionSourceMSSQL</command:name> <command:verb>Register</command:verb> <command:noun>CohesityProtectionSourceMSSQL</command:noun> <maml:description> <maml:para>Registers an existing source as running MS SQL application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Registers an existing source as running MS SQL application.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: UseAgent --> <command:syntaxItem> <maml:name>Register-CohesityProtectionSourceMSSQL</maml:name> <!-- Parameter: HasPersistentAgent --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>HasPersistentAgent</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Id of the Protection Source that has MS SQL Application Server running on it.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: UseCredential --> <command:syntaxItem> <maml:name>Register-CohesityProtectionSourceMSSQL</maml:name> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>User credentials used to connect to the host.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Id of the Protection Source that has MS SQL Application Server running on it.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Id of the Protection Source that has MS SQL Application Server running on it.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: HasPersistentAgent --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>HasPersistentAgent</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>User credentials used to connect to the host.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the Id of the Protection Source that has MS SQL Application Server running on it.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ProtectionSource --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.ProtectionSource</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Register-CohesityProtectionSourceMSSQL -Id $sourceId -HasPersistentAgent</dev:code> <dev:remarks> <maml:para>Registers the specified source as running MS SQL application and uses the installed agent to connect.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Register-CohesityProtectionSourceMSSQL -Id $sourceId -Credential (Get-Credential)</dev:code> <dev:remarks> <maml:para>Registers the specified source as running MS SQL application and connects using provided credentials.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Register-CohesityProtectionSourceNetApp --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Register-CohesityProtectionSourceNetApp</command:name> <command:verb>Register</command:verb> <command:noun>CohesityProtectionSourceNetApp</command:noun> <maml:description> <maml:para>Registers a new NetApp protection source with the Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Registers a new NetApp protection source with the Cohesity Cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Register-CohesityProtectionSourceNetApp</maml:name> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>User credentials for the NetApp cluster or Vserver.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Hostname or IP Address for the NetApp cluster or Vserver.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of NetApp server. Must be set to KCluster or KVserver.</maml:para> <maml:para>Possible values: KCluster, KVserver</maml:para> </maml:description> <command:parameterValue required="true">NetappTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RegisterProtectionSourceParameters+NetappTypeEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KCluster</command:parameterValue> <command:parameterValue required="false" variableLength="false">KVserver</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Hostname or IP Address for the NetApp cluster or Vserver.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>User credentials for the NetApp cluster or Vserver.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of NetApp server. Must be set to KCluster or KVserver.</maml:para> <maml:para>Possible values: KCluster, KVserver</maml:para> </maml:description> <command:parameterValue required="true">NetappTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RegisterProtectionSourceParameters+NetappTypeEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KCluster</command:parameterValue> <command:parameterValue required="false" variableLength="false">KVserver</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ProtectionSource --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.ProtectionSource</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Register-CohesityProtectionSourceNetApp -Server netapp-cluster.example.com -Type KCluster -Credential (Get-Credential)</dev:code> <dev:remarks> <maml:para>Registers a new NetApp cluster with hostname "netapp-cluster.example.com" with the Cohesity Cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Register-CohesityProtectionSourceNFS --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Register-CohesityProtectionSourceNFS</command:name> <command:verb>Register</command:verb> <command:noun>CohesityProtectionSourceNFS</command:noun> <maml:description> <maml:para>Registers a new NFS mount point as protection source with the Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Registers a new NFS mount point as protection source with the Cohesity Cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Register-CohesityProtectionSourceNFS</maml:name> <!-- Parameter: MountPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MountPath</maml:name> <maml:description> <maml:para>NFS Mount path.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: MountPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MountPath</maml:name> <maml:description> <maml:para>NFS Mount path.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ProtectionSource --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.ProtectionSource</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Register-CohesityProtectionSourceNFS -MountPath "file-server.example.com:/sourcevol"</dev:code> <dev:remarks> <maml:para>Registers a new NFS mount point with mount path "file-server.example.com:/sourcevol" with the Cohesity Cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Register-CohesityProtectionSourcePhysical --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Register-CohesityProtectionSourcePhysical</command:name> <command:verb>Register</command:verb> <command:noun>CohesityProtectionSourcePhysical</command:noun> <maml:description> <maml:para>Registers a new Physical protection source with the Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Registers a new Physical protection source with the Cohesity Cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Register-CohesityProtectionSourcePhysical</maml:name> <!-- Parameter: HostType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>HostType</maml:name> <maml:description> <maml:para>Type of host. Must be set to KLinux or KWindows.</maml:para> <maml:para>Possible values: KLinux, KWindows, KAix, KSolaris, KSapHana, KSapOracle, KCockroachDB, KMySQL, KOther, KSapSybase, KSapMaxDB, KSapSybaseIQ, KDB2, KSapASE, KMariaDB, KPostgreSQL, KVOS, KHPUX</maml:para> </maml:description> <command:parameterValue required="true">HostTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RegisterProtectionSourceParameters+HostTypeEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KLinux</command:parameterValue> <command:parameterValue required="false" variableLength="false">KWindows</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAix</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSolaris</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapHana</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapOracle</command:parameterValue> <command:parameterValue required="false" variableLength="false">KCockroachDB</command:parameterValue> <command:parameterValue required="false" variableLength="false">KMySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">KOther</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapSybase</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapMaxDB</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapSybaseIQ</command:parameterValue> <command:parameterValue required="false" variableLength="false">KDB2</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapASE</command:parameterValue> <command:parameterValue required="false" variableLength="false">KMariaDB</command:parameterValue> <command:parameterValue required="false" variableLength="false">KPostgreSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">KVOS</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHPUX</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: PhysicalType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PhysicalType</maml:name> <maml:description> <maml:para>Type of physical host. Must be set to KHost or KWindowsCluster.</maml:para> <maml:para>Possible values: KHost</maml:para> </maml:description> <command:parameterValue required="true">PhysicalTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RegisterProtectionSourceParameters+PhysicalTypeEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KHost</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Hostname or IP Address of the Physical server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Hostname or IP Address of the Physical server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HostType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>HostType</maml:name> <maml:description> <maml:para>Type of host. Must be set to KLinux or KWindows.</maml:para> <maml:para>Possible values: KLinux, KWindows, KAix, KSolaris, KSapHana, KSapOracle, KCockroachDB, KMySQL, KOther, KSapSybase, KSapMaxDB, KSapSybaseIQ, KDB2, KSapASE, KMariaDB, KPostgreSQL, KVOS, KHPUX</maml:para> </maml:description> <command:parameterValue required="true">HostTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RegisterProtectionSourceParameters+HostTypeEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KLinux</command:parameterValue> <command:parameterValue required="false" variableLength="false">KWindows</command:parameterValue> <command:parameterValue required="false" variableLength="false">KAix</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSolaris</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapHana</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapOracle</command:parameterValue> <command:parameterValue required="false" variableLength="false">KCockroachDB</command:parameterValue> <command:parameterValue required="false" variableLength="false">KMySQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">KOther</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapSybase</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapMaxDB</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapSybaseIQ</command:parameterValue> <command:parameterValue required="false" variableLength="false">KDB2</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSapASE</command:parameterValue> <command:parameterValue required="false" variableLength="false">KMariaDB</command:parameterValue> <command:parameterValue required="false" variableLength="false">KPostgreSQL</command:parameterValue> <command:parameterValue required="false" variableLength="false">KVOS</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHPUX</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: PhysicalType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PhysicalType</maml:name> <maml:description> <maml:para>Type of physical host. Must be set to KHost or KWindowsCluster.</maml:para> <maml:para>Possible values: KHost</maml:para> </maml:description> <command:parameterValue required="true">PhysicalTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RegisterProtectionSourceParameters+PhysicalTypeEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KHost</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ProtectionSource --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.ProtectionSource</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Register-CohesityProtectionSourcePhysical -Server server.example.com -HostType KLinux -PhysicalType KHost</dev:code> <dev:remarks> <maml:para>Registers a physical linux server with hostname "server.example.com" with the Cohesity Cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Register-CohesityProtectionSourcePureStorageArray --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Register-CohesityProtectionSourcePureStorageArray</command:name> <command:verb>Register</command:verb> <command:noun>CohesityProtectionSourcePureStorageArray</command:noun> <maml:description> <maml:para>Registers a new Pure Storage array as a protection source.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Registers a new Pure Storage array as a protection source with the Cohesity Cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Register-CohesityProtectionSourcePureStorageArray</maml:name> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>User credentials for the Pure Storage array.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Hostname or IP Address for the Pure Storage array.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Hostname or IP Address for the Pure Storage array.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>User credentials for the Pure Storage array.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ProtectionSource --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.ProtectionSource</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Register-CohesityProtectionSourcePureStorageArray -Server pure.example.com -Credential (Get-Credential)</dev:code> <dev:remarks> <maml:para>Registers a new Pure Storage array with hostname "pure.example.com" with the Cohesity Cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Register-CohesityProtectionSourceSMB --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Register-CohesityProtectionSourceSMB</command:name> <command:verb>Register</command:verb> <command:noun>CohesityProtectionSourceSMB</command:noun> <maml:description> <maml:para>Registers a new SMB file share as protection source with the Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Registers a new SMB file share as protection source with the Cohesity Cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Register-CohesityProtectionSourceSMB</maml:name> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>User credentials for accessing the SMB file share.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MountPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MountPath</maml:name> <maml:description> <maml:para>NFS Mount path.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SkipValidation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipValidation</maml:name> <maml:description> <maml:para>Skip SMB validation registration</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: MountPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MountPath</maml:name> <maml:description> <maml:para>NFS Mount path.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>User credentials for accessing the SMB file share.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SkipValidation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipValidation</maml:name> <maml:description> <maml:para>Skip SMB validation registration</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ProtectionSource --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.ProtectionSource</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Register-CohesityProtectionSourceSMB -MountPath "\\smb-server.example.com\share -Credential (Get-Credential)"</dev:code> <dev:remarks> <maml:para>Registers a new SMB file share with mount path "\\smb-server.example.com\share" with the Cohesity Cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Register-CohesityProtectionSourceVMware --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Register-CohesityProtectionSourceVMware</command:name> <command:verb>Register</command:verb> <command:noun>CohesityProtectionSourceVMware</command:noun> <maml:description> <maml:para>Registers a new VMware protection source.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Registers a new VMware protection source with the Cohesity Cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Register-CohesityProtectionSourceVMware</maml:name> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>User credentials for the vCenter server or ESXi host.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Hostname or IP Address for the vCenter server or ESXi server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of VMware server. Must be set to KStandaloneHost or KVcenter.</maml:para> <maml:para>Possible values: KVCenter, KStandaloneHost, KvCloudDirector</maml:para> </maml:description> <command:parameterValue required="true">VmwareTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RegisterProtectionSourceParameters+VmwareTypeEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KVCenter</command:parameterValue> <command:parameterValue required="false" variableLength="false">KStandaloneHost</command:parameterValue> <command:parameterValue required="false" variableLength="false">KvCloudDirector</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Hostname or IP Address for the vCenter server or ESXi server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of VMware server. Must be set to KStandaloneHost or KVcenter.</maml:para> <maml:para>Possible values: KVCenter, KStandaloneHost, KvCloudDirector</maml:para> </maml:description> <command:parameterValue required="true">VmwareTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RegisterProtectionSourceParameters+VmwareTypeEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KVCenter</command:parameterValue> <command:parameterValue required="false" variableLength="false">KStandaloneHost</command:parameterValue> <command:parameterValue required="false" variableLength="false">KvCloudDirector</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>User credentials for the vCenter server or ESXi host.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ProtectionSource --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.ProtectionSource</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Register-CohesityProtectionSourceVMware -Server vcenter.example.com -Type KVcenter -Credential (Get-Credential)</dev:code> <dev:remarks> <maml:para>Registers a new vCenter server with hostname "vcenter.example.com" with the Cohesity Cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CohesityRemoteCluster --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CohesityRemoteCluster</command:name> <command:verb>Get</command:verb> <command:noun>CohesityRemoteCluster</command:noun> <maml:description> <maml:para>Gets a list of the remote clusters registered with the Cohesity Cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>All remote clusters that are registered with the Cohesity Cluster are returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityRemoteCluster</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: RemoteCluster --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.RemoteCluster</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Get-CohesityRemoteCluster</dev:code> <dev:remarks> <maml:para>Returns all the registered remote clusters.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Register-CohesityRemoteCluster --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Register-CohesityRemoteCluster</command:name> <command:verb>Register</command:verb> <command:noun>CohesityRemoteCluster</command:noun> <maml:description> <maml:para>Registers a remote Cohesity Cluster with the local Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Registers a remote Cohesity Cluster with the local Cohesity Cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Register-CohesityRemoteCluster</maml:name> <!-- Parameter: RemoteClusterCredential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoteClusterCredential</maml:name> <maml:description> <maml:para>User credentials for the remote cluster.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RemoteClusterIps --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoteClusterIps</maml:name> <maml:description> <maml:para>Remote cluster VIP or node IP addresses.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BandwidthLimitMbps --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BandwidthLimitMbps</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EnableOutBoundCompression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableOutBoundCompression</maml:name> <maml:description> <maml:para>If specified, compresses the outbound data when transferring the replication data over the network to the remote cluster.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableRemoteAccess --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableRemoteAccess</maml:name> <maml:description> <maml:para>If specified, enables management of the remote cluster from the local cluster.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableReplication --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableReplication</maml:name> <maml:description> <maml:para>If specified, indicates that the remote cluster will be used for replication.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EncryptionKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EncryptionKey</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageDomainPairs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageDomainPairs</maml:name> <maml:description> <maml:para>If specified, compresses the outbound data when transferring the replication data over the network to the remote cluster.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable[]</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: RemoteClusterIps --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoteClusterIps</maml:name> <maml:description> <maml:para>Remote cluster VIP or node IP addresses.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RemoteClusterCredential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoteClusterCredential</maml:name> <maml:description> <maml:para>User credentials for the remote cluster.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EnableRemoteAccess --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableRemoteAccess</maml:name> <maml:description> <maml:para>If specified, enables management of the remote cluster from the local cluster.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableReplication --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableReplication</maml:name> <maml:description> <maml:para>If specified, indicates that the remote cluster will be used for replication.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableOutBoundCompression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableOutBoundCompression</maml:name> <maml:description> <maml:para>If specified, compresses the outbound data when transferring the replication data over the network to the remote cluster.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: StorageDomainPairs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageDomainPairs</maml:name> <maml:description> <maml:para>If specified, compresses the outbound data when transferring the replication data over the network to the remote cluster.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable[]</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EncryptionKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EncryptionKey</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BandwidthLimitMbps --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BandwidthLimitMbps</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: RemoteCluster --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.RemoteCluster</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Register-CohesityRemoteCluster -RemoteClusterIps 10.2.37.210 -RemoteClusterCredential (Get-Credential) -EnableReplication -EnableRemoteAccess -StorageDomainPairs @{LocalStorageDomainId=5;LocalStorageDomainName="DefaultStorageDomain";RemoteStorageDomainId=5;RemoteStorageDomainName="DefaultStorageDomain"}</dev:code> <dev:remarks> <maml:para>Registers a new remote Cohesity Cluster with Cluster VIP (10.2.37.210) with the local Cohesity Cluster with the specified parameters.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CohesityRemoteCluster --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-CohesityRemoteCluster</command:name> <command:verb>Set</command:verb> <command:noun>CohesityRemoteCluster</command:noun> <maml:description> <maml:para>Updates a remote cluster registered with the Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the updated remote cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-CohesityRemoteCluster</maml:name> <!-- Parameter: RemoteCluster --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>RemoteCluster</maml:name> <maml:description> <maml:para>The updated remote cluster.</maml:para> </maml:description> <command:parameterValue required="true">RemoteCluster</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RemoteCluster</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: RemoteCluster --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>RemoteCluster</maml:name> <maml:description> <maml:para>The updated remote cluster.</maml:para> </maml:description> <command:parameterValue required="true">RemoteCluster</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RemoteCluster</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Cohesity.Model.RemoteCluster</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The updated remote cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: RemoteCluster --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.RemoteCluster</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>$remoteCluster = Get-CohesityRemoteCluster $remoteCluster.AllEndpointsReachable = $true Set-CohesityRemoteCluster -RemoteCluster $remoteCluster</dev:code> <dev:remarks> <maml:para>Updates a remote cluster with the specified parameters.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Unregister-CohesityRemoteCluster --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Unregister-CohesityRemoteCluster</command:name> <command:verb>Unregister</command:verb> <command:noun>CohesityRemoteCluster</command:noun> <maml:description> <maml:para>Unregisters the specified remote cluster from the Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Unregisters the specified remote cluster from the Cohesity Cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Unregister-CohesityRemoteCluster</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies a unique id of the remote cluster.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Unregister-CohesityRemoteCluster</maml:name> <!-- Parameter: RemoteCluster --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>RemoteCluster</maml:name> <maml:description> <maml:para>Specifies a remote cluster object.</maml:para> </maml:description> <command:parameterValue required="true">RemoteCluster</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RemoteCluster</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies a unique id of the remote cluster.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: RemoteCluster --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>RemoteCluster</maml:name> <maml:description> <maml:para>Specifies a remote cluster object.</maml:para> </maml:description> <command:parameterValue required="true">RemoteCluster</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RemoteCluster</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies a unique id of the remote cluster.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Cohesity.Model.RemoteCluster</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies a remote cluster object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Unregister-CohesityRemoteCluster -ClusterId 7539516053202252</dev:code> <dev:remarks> <maml:para>Unregisters the given remote cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-CohesityReplicationEncryptionKey --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-CohesityReplicationEncryptionKey</command:name> <command:verb>New</command:verb> <command:noun>CohesityReplicationEncryptionKey</command:noun> <maml:description> <maml:para>Generates a new encryption key that can be used for encrypting replication data between this Cluster and a remote Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Generates a new encryption key that can be used for encrypting replication data between this Cluster and a remote Cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-CohesityReplicationEncryptionKey</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Get-CohesityReplicationEncryptionKey</dev:code> <dev:remarks> <maml:para>Gets a new encryption key that can be used for encrypting replication data between this Cluster and a remote Cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CohesityRestoreTask --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CohesityRestoreTask</command:name> <command:verb>Get</command:verb> <command:noun>CohesityRestoreTask</command:noun> <maml:description> <maml:para>Gets a list of the restore tasks filtered by the specified parameters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If no parameters are specified, all the restore tasks on the Cohesity Cluster are returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityRestoreTask</maml:name> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Ids --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ids</maml:name> <maml:description> <maml:para>Filter by a list of task ids.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Types --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Types</maml:name> <maml:description> <maml:para>Filter by a list of task types, such as 'kRecoverVMs’, 'kCloneVMs’, ‘kCloneView’ or 'kMountVolumes’.</maml:para> </maml:description> <command:parameterValue required="true">TypeEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RestoreTask+TypeEnum[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Ids --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ids</maml:name> <maml:description> <maml:para>Filter by a list of task ids.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Types --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Types</maml:name> <maml:description> <maml:para>Filter by a list of task types, such as 'kRecoverVMs’, 'kCloneVMs’, ‘kCloneView’ or 'kMountVolumes’.</maml:para> </maml:description> <command:parameterValue required="true">TypeEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.RestoreTask+TypeEnum[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: RestoreTask --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.RestoreTask</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Get-CohesityRestoreTask -Types kRecoverVMs</dev:code> <dev:remarks> <maml:para>Returns only the restore tasks that match the type 'kRecoverVMs'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Stop-CohesityRestoreTask --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Stop-CohesityRestoreTask</command:name> <command:verb>Stop</command:verb> <command:noun>CohesityRestoreTask</command:noun> <maml:description> <maml:para>Cancels a restore task.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Stop-CohesityRestoreTask</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies a unique id of the restore task.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies a unique id of the restore task.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies a unique id of the restore task.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Stop-CohesityRestoreTask -Id 78</dev:code> <dev:remarks> <maml:para>Cancels a running restore task with Id 78.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CohesityRole --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CohesityRole</command:name> <command:verb>Get</command:verb> <command:noun>CohesityRole</command:noun> <maml:description> <maml:para>Gets the roles defined on the Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the roles defined on the Cohesity Cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityRole</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Role.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Role.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Role --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.Role</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Get-CohesityRole -Name COHESITY_ADMIN</dev:code> <dev:remarks> <maml:para>Gets the role with the name COHESITY_ADMIN.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Get-CohesityRole</dev:code> <dev:remarks> <maml:para>Gets all the roles on the Cohesity Cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CohesitySnapshot --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CohesitySnapshot</command:name> <command:verb>Remove</command:verb> <command:noun>CohesitySnapshot</command:noun> <maml:description> <maml:para>Removes the Cohesity snapshots associated with a Protection Job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns success if the snapshots associated with the specified Protection Job are expired successfully.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ObjectModel --> <command:syntaxItem> <maml:name>Remove-CohesitySnapshot</maml:name> <!-- Parameter: JobObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>JobObject</maml:name> <maml:description> <maml:para>The piped job object.</maml:para> </maml:description> <command:parameterValue required="true">ProtectionRunInstance</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionRunInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceIds</maml:name> <maml:description> <maml:para>Specifies the source ids to only expire snapshots belonging to those source ids.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: JobName --> <command:syntaxItem> <maml:name>Remove-CohesitySnapshot</maml:name> <!-- Parameter: JobName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JobName</maml:name> <maml:description> <maml:para>The name of the Protection Job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JobRunId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JobRunId</maml:name> <maml:description> <maml:para>The unique id of the Protection Job Run.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SourceIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceIds</maml:name> <maml:description> <maml:para>Specifies the source ids to only expire snapshots belonging to those source ids.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: JobObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>JobObject</maml:name> <maml:description> <maml:para>The piped job object.</maml:para> </maml:description> <command:parameterValue required="true">ProtectionRunInstance</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.ProtectionRunInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JobName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JobName</maml:name> <maml:description> <maml:para>The name of the Protection Job.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JobRunId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JobRunId</maml:name> <maml:description> <maml:para>The unique id of the Protection Job Run.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SourceIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceIds</maml:name> <maml:description> <maml:para>Specifies the source ids to only expire snapshots belonging to those source ids.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Cohesity.Model.ProtectionRunInstance</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The piped job object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Remove-CohesitySnapshot -JobName Test-Job -JobRunId 2123</dev:code> <dev:remarks> <maml:para>Expires the snapshots associated with the specified Protection Job and Job Run Id.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Remove-CohesitySnapshot -JobName Test-Job -JobRunId 2123 -SourceIds 883</dev:code> <dev:remarks> <maml:para>Expires the snapshots associated with only the specified Source Id (such as a VM), Protection Job and Job Run Id.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Convert-CohesityUsecsToDateTime --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Convert-CohesityUsecsToDateTime</command:name> <command:verb>Convert</command:verb> <command:noun>CohesityUsecsToDateTime</command:noun> <maml:description> <maml:para>Converts the unix timestamp in microseconds to DateTime format.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Converts the unix timestamp in microseconds to DateTime format.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Convert-CohesityUsecsToDateTime</maml:name> <!-- Parameter: Usecs --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Usecs</maml:name> <maml:description> <maml:para>Timestamp in microseconds.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Usecs --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Usecs</maml:name> <maml:description> <maml:para>Timestamp in microseconds.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Timestamp in microseconds.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DateTime --> <command:returnValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Convert-CohesityUsecsToDateTime -Usecs 1537272612321018</dev:code> <dev:remarks> <maml:para>Converts the unix timestamp in microseconds to its corresponding DateTime value such as: Tuesday, September 18, 2018 5:10:12 AM.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CohesityUser --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CohesityUser</command:name> <command:verb>Get</command:verb> <command:noun>CohesityUser</command:noun> <maml:description> <maml:para>Gets the users defined on the Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the users defined on the Cohesity Cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityUser</maml:name> <!-- Parameter: Domain --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Specifies the domain name to filter the results.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EmailAddresses --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailAddresses</maml:name> <maml:description> <maml:para>Specifies a list of email addresses to filter the results.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Names --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Names</maml:name> <maml:description> <maml:para>Specifies a list of user names to filter the results.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Names --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Names</maml:name> <maml:description> <maml:para>Specifies a list of user names to filter the results.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EmailAddresses --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailAddresses</maml:name> <maml:description> <maml:para>Specifies a list of email addresses to filter the results.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Specifies the domain name to filter the results.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: User --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.User</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Get-CohesityUser -Names admin,test-user</dev:code> <dev:remarks> <maml:para>Gets the details of the users with the names "admin" and "test-user".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Get-CohesityUser -Domain example.com</dev:code> <dev:remarks> <maml:para>Gets the details of all the users with the domain name as "example.com".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Get-CohesityUser</dev:code> <dev:remarks> <maml:para>Gets the details of all the users on the Cohesity Cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-CohesityUser --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-CohesityUser</command:name> <command:verb>New</command:verb> <command:noun>CohesityUser</command:noun> <maml:description> <maml:para>Creates a new Cohesity User.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the created Cohesity User.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-CohesityUser</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the User to be created.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Roles --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Roles</maml:name> <maml:description> <maml:para>Specifies one or more roles for the User to be created.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description for the User to be created.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EffectiveTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EffectiveTime</maml:name> <maml:description> <maml:para>Specifies the effective time for this User.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/27/2024 8:58:01 PM</dev:defaultValue> </command:parameter> <!-- Parameter: EmailAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>Specifies the email address for the User to be created.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password for the User to be created. This is mandatory in case of a LOCAL user.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Restricted --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Restricted</maml:name> <maml:description> <maml:para>Specifies whether the created user has restricted access.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the User to be created.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password for the User to be created. This is mandatory in case of a LOCAL user.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Roles --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Roles</maml:name> <maml:description> <maml:para>Specifies one or more roles for the User to be created.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EmailAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>Specifies the email address for the User to be created.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description for the User to be created.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Restricted --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Restricted</maml:name> <maml:description> <maml:para>Specifies whether the created user has restricted access.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EffectiveTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EffectiveTime</maml:name> <maml:description> <maml:para>Specifies the effective time for this User.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/27/2024 8:58:01 PM</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: User --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.User</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>New-CohesityUser -Name test-user -Password password -Roles COHESITY_ADMIN</dev:code> <dev:remarks> <maml:para>Creates a new Cohesity User in default LOCAL domain called "test-user" with COHESITY_ADMIN role.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CohesityView --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CohesityView</command:name> <command:verb>Get</command:verb> <command:noun>CohesityView</command:noun> <maml:description> <maml:para>Gets a list of views filtered by specified parameters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If no parameters are specified, all views on the Cohesity Cluster are returned. Specifying parameters filters the results that are returned.</maml:para> <maml:para>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.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityView</maml:name> <!-- Parameter: IncludeInactive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeInactive</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeStats --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeStats</maml:name> <maml:description> <maml:para>If set, the results will include statistics.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: JobIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobIds</maml:name> <maml:description> <maml:para>Filter by Protection Job ids. Return Views that are being protected by listed Jobs, which are specified by ids.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MatchAliasNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchAliasNames</maml:name> <maml:description> <maml:para>If set, View aliases are also matched with the names specified by ViewNames parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchPartialNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchPartialNames</maml:name> <maml:description> <maml:para>If set, the names in ViewNames are matched by prefix rather than an exact match.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaxCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies a limit on the number of Views returned.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaxViewId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxViewId</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SortByLogicalUsage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SortByLogicalUsage</maml:name> <maml:description> <maml:para>If set, the results are sorted in descending order by logical usage.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ViewBoxIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ViewBoxIds</maml:name> <maml:description> <maml:para>Filter by a list of Storage Domains (View Boxes) specified by id.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ViewBoxNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ViewBoxNames</maml:name> <maml:description> <maml:para>Filter by a list of View Box names.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ViewNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ViewNames</maml:name> <maml:description> <maml:para>Filter by a list of View names.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IncludeInactive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeInactive</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchAliasNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchAliasNames</maml:name> <maml:description> <maml:para>If set, View aliases are also matched with the names specified by ViewNames parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ViewNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ViewNames</maml:name> <maml:description> <maml:para>Filter by a list of View names.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ViewBoxIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ViewBoxIds</maml:name> <maml:description> <maml:para>Filter by a list of Storage Domains (View Boxes) specified by id.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ViewBoxNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ViewBoxNames</maml:name> <maml:description> <maml:para>Filter by a list of View Box names.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MatchPartialNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchPartialNames</maml:name> <maml:description> <maml:para>If set, the names in ViewNames are matched by prefix rather than an exact match.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaxCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies a limit on the number of Views returned.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaxViewId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxViewId</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JobIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobIds</maml:name> <maml:description> <maml:para>Filter by Protection Job ids. Return Views that are being protected by listed Jobs, which are specified by ids.</maml:para> </maml:description> <command:parameterValue required="true">long[]</command:parameterValue> <dev:type> <maml:name>System.Int64[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SortByLogicalUsage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SortByLogicalUsage</maml:name> <maml:description> <maml:para>If set, the results are sorted in descending order by logical usage.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeStats --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeStats</maml:name> <maml:description> <maml:para>If set, the results will include statistics.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: View --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.View</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Get-CohesityView -ViewNames Test-view</dev:code> <dev:remarks> <maml:para>Displays the view with the name "Test-view".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-CohesityView --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-CohesityView</command:name> <command:verb>New</command:verb> <command:noun>CohesityView</command:noun> <maml:description> <maml:para>Creates a new Cohesity View.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the created Cohesity View.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-CohesityView</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the View to be created.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageDomainName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageDomainName</maml:name> <maml:description> <maml:para>Specifies the Storage Domain name for this View.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AccessProtocol --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessProtocol</maml:name> <maml:description> <maml:para>Specifies the supported protocols for this View. If not specified, default is kAll which means all protocols are supported.</maml:para> <maml:para>Possible values: KAll, KNFSOnly, KSMBOnly, KS3Only, KSwiftOnly, KUnknown</maml:para> </maml:description> <command:parameterValue required="true">ProtocolAccessEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.View+ProtocolAccessEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>KAll</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KAll</command:parameterValue> <command:parameterValue required="false" variableLength="false">KNFSOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSMBOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">KS3Only</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSwiftOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">KUnknown</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: AlertQuotaInBytes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AlertQuotaInBytes</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BrowsableShares --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BrowsableShares</maml:name> <maml:description> <maml:para>Specifies whether the shares from this View are browsable. This is not enabled by default.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: CaseInsensitiveNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CaseInsensitiveNames</maml:name> <maml:description> <maml:para>Specifies whether to support case insensitive file/folder names. This is not enabled by default.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description for this View.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisableInlineDedupAndCompression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableInlineDedupAndCompression</maml:name> <maml:description> <maml:para>Specifies whether inline deduplication and compression settings inherited from the Storage Domain should be disabled for this View.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LogicalQuotaInBytes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalQuotaInBytes</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QosPolicy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QosPolicy</maml:name> <maml:description> <maml:para>Specifies the Quality of Service (QoS) Policy for this View. If not specified, the default is 'Backup Target Low'</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Backup Target Low</dev:defaultValue> </command:parameter> <!-- Parameter: SmbAccessBasedEnumeration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SmbAccessBasedEnumeration</maml:name> <maml:description> <maml:para>Specifies whether SMB Access Based Enumeration is enabled. This is not enabled by default.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the View to be created.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description for this View.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AccessProtocol --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessProtocol</maml:name> <maml:description> <maml:para>Specifies the supported protocols for this View. If not specified, default is kAll which means all protocols are supported.</maml:para> <maml:para>Possible values: KAll, KNFSOnly, KSMBOnly, KS3Only, KSwiftOnly, KUnknown</maml:para> </maml:description> <command:parameterValue required="true">ProtocolAccessEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.View+ProtocolAccessEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>KAll</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KAll</command:parameterValue> <command:parameterValue required="false" variableLength="false">KNFSOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSMBOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">KS3Only</command:parameterValue> <command:parameterValue required="false" variableLength="false">KSwiftOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">KUnknown</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: QosPolicy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QosPolicy</maml:name> <maml:description> <maml:para>Specifies the Quality of Service (QoS) Policy for this View. If not specified, the default is 'Backup Target Low'</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Backup Target Low</dev:defaultValue> </command:parameter> <!-- Parameter: StorageDomainName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageDomainName</maml:name> <maml:description> <maml:para>Specifies the Storage Domain name for this View.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogicalQuotaInBytes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalQuotaInBytes</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AlertQuotaInBytes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AlertQuotaInBytes</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CaseInsensitiveNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CaseInsensitiveNames</maml:name> <maml:description> <maml:para>Specifies whether to support case insensitive file/folder names. This is not enabled by default.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BrowsableShares --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BrowsableShares</maml:name> <maml:description> <maml:para>Specifies whether the shares from this View are browsable. This is not enabled by default.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SmbAccessBasedEnumeration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SmbAccessBasedEnumeration</maml:name> <maml:description> <maml:para>Specifies whether SMB Access Based Enumeration is enabled. This is not enabled by default.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DisableInlineDedupAndCompression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableInlineDedupAndCompression</maml:name> <maml:description> <maml:para>Specifies whether inline deduplication and compression settings inherited from the Storage Domain should be disabled for this View.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: View --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.View</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>New-CohesityView -Name 'Test-View' -AccessProtocol KS3Only -StorageDomainName 'Test-Storage-Domain'</dev:code> <dev:remarks> <maml:para>Creates a new Cohesity View only accessible via S3 protocol using Storage Domain with name 'Test-Storage-Domain'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CohesityView --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CohesityView</command:name> <command:verb>Remove</command:verb> <command:noun>CohesityView</command:noun> <maml:description> <maml:para>Removes a Cohesity View.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns success if the view is deleted.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-CohesityView</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the View to be deleted.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the View to be deleted.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of the View to be deleted.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Remove-CohesityView -Name "Test-View"</dev:code> <dev:remarks> <maml:para>Removes a view with the name "Test-View".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CohesityView --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-CohesityView</command:name> <command:verb>Set</command:verb> <command:noun>CohesityView</command:noun> <maml:description> <maml:para>Updates a Cohesity View.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the updated Cohesity View.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-CohesityView</maml:name> <!-- Parameter: View --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>View</maml:name> <maml:description> <maml:para>The updated View.</maml:para> </maml:description> <command:parameterValue required="true">View</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.View</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: View --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>View</maml:name> <maml:description> <maml:para>The updated View.</maml:para> </maml:description> <command:parameterValue required="true">View</command:parameterValue> <dev:type> <maml:name>Cohesity.Model.View</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Cohesity.Model.View</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The updated View.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: View --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.View</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Set-CohesityView -View $view</dev:code> <dev:remarks> <maml:para>Updates a Cohesity View.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev: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</dev:code> <dev:remarks> <maml:para>Override global whitelist.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-CohesityViewShare --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-CohesityViewShare</command:name> <command:verb>Add</command:verb> <command:noun>CohesityViewShare</command:noun> <maml:description> <maml:para>Adds a new share to a Cohesity View.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a new share to a Cohesity View.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-CohesityViewShare</maml:name> <!-- Parameter: ShareName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ShareName</maml:name> <maml:description> <maml:para>Specifies the name of the Share to be created.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ViewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ViewName</maml:name> <maml:description> <maml:para>Specifies the name of the View.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ViewPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ViewPath</maml:name> <maml:description> <maml:para>Specifies a directory path inside the View to be mounted using this Share. If not specified, '/' will be used as the default path.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>/</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ViewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ViewName</maml:name> <maml:description> <maml:para>Specifies the name of the View.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ShareName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ShareName</maml:name> <maml:description> <maml:para>Specifies the name of the Share to be created.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ViewPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ViewPath</maml:name> <maml:description> <maml:para>Specifies a directory path inside the View to be mounted using this Share. If not specified, '/' will be used as the default path.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>/</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ViewAlias --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.ViewAlias</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Add-CohesityViewShare -ViewName 'Test-View' -ShareName 'Test-Share' -ViewPath '/'</dev:code> <dev:remarks> <maml:para>Adds a new share called 'Test-Share' using a Cohesity View named 'Test-View' mapped to the directory path '/' inside the View.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CohesityViewShare --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CohesityViewShare</command:name> <command:verb>Get</command:verb> <command:noun>CohesityViewShare</command:noun> <maml:description> <maml:para>Gets a list of shares associated with a view.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a list of shares associated with a view.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityViewShare</maml:name> <!-- Parameter: ViewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ViewName</maml:name> <maml:description> <maml:para>Name of the View</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ViewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ViewName</maml:name> <maml:description> <maml:para>Name of the View</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: View --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.View</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Get-CohesityViewShare -ViewName Test-view</dev:code> <dev:remarks> <maml:para>Displays the shares associated with a view with the name "Test-view".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CohesityViewShare --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CohesityViewShare</command:name> <command:verb>Remove</command:verb> <command:noun>CohesityViewShare</command:noun> <maml:description> <maml:para>Removes a Share associated with a Cohesity View .</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns success if the Share is deleted.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-CohesityViewShare</maml:name> <!-- Parameter: ShareName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ShareName</maml:name> <maml:description> <maml:para>Specifies the name of the View to be deleted.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ShareName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ShareName</maml:name> <maml:description> <maml:para>Specifies the name of the View to be deleted.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the name of the View to be deleted.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Remove-CohesityViewShare -ShareName "Test-Share"</dev:code> <dev:remarks> <maml:para>Removes a share with the name "Test-Share".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Copy-CohesityVMwareVM --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Copy-CohesityVMwareVM</command:name> <command:verb>Copy</command:verb> <command:noun>CohesityVMwareVM</command:noun> <maml:description> <maml:para>Clones the specified VMware virtual machine.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Clones the specified VMware virtual machine.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Copy-CohesityVMwareVM</maml:name> <!-- Parameter: JobId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the job id that backed up this VM and will be used for cloning.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ResourcePoolId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourcePoolId</maml:name> <maml:description> <maml:para>Specifies the resource pool where the VM should be cloned.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceId</maml:name> <maml:description> <maml:para>Specifies the source id of the VM to be cloned.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: TargetViewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetViewName</maml:name> <maml:description> <maml:para>Specifies the name of the View where the cloned VM is stored.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TaskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>Specifies the name of the clone task.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatastoreFolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatastoreFolderId</maml:name> <maml:description> <maml:para>Specifies the folder where the datastore should be created when the VM is being cloned.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisableNetwork --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableNetwork</maml:name> <maml:description> <maml:para>Specifies whether the network should be left in disabled state.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: JobRunId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobRunId</maml:name> <maml:description> <maml:para>Specifies the job run id that captured the snapshot for this VM. If not specified the latest run is used.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NetworkId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkId</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewParentId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewParentId</maml:name> <maml:description> <maml:para>Specifies a new parent source such as vCenter to clone the VM. If not specified, the VM is cloned to its original parent source.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PoweredOn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PoweredOn</maml:name> <maml:description> <maml:para>Specifies the power state of the cloned VM. By default, the VM is powered off.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VmFolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmFolderId</maml:name> <maml:description> <maml:para>Specifies the folder where the VM should be cloned. This is applicable only when the VM is being cloned to an alternate location.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VmNamePrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmNamePrefix</maml:name> <maml:description> <maml:para>Specifies the prefix to add to the name of the cloned VM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VmNameSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmNameSuffix</maml:name> <maml:description> <maml:para>Specifies the suffix to add to the name of the cloned VM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TaskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>Specifies the name of the clone task.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetViewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetViewName</maml:name> <maml:description> <maml:para>Specifies the name of the View where the cloned VM is stored.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceId</maml:name> <maml:description> <maml:para>Specifies the source id of the VM to be cloned.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: JobId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the job id that backed up this VM and will be used for cloning.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: JobRunId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobRunId</maml:name> <maml:description> <maml:para>Specifies the job run id that captured the snapshot for this VM. If not specified the latest run is used.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VmNamePrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmNamePrefix</maml:name> <maml:description> <maml:para>Specifies the prefix to add to the name of the cloned VM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VmNameSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmNameSuffix</maml:name> <maml:description> <maml:para>Specifies the suffix to add to the name of the cloned VM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisableNetwork --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableNetwork</maml:name> <maml:description> <maml:para>Specifies whether the network should be left in disabled state.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PoweredOn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PoweredOn</maml:name> <maml:description> <maml:para>Specifies the power state of the cloned VM. By default, the VM is powered off.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DatastoreFolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatastoreFolderId</maml:name> <maml:description> <maml:para>Specifies the folder where the datastore should be created when the VM is being cloned.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NetworkId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkId</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourcePoolId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourcePoolId</maml:name> <maml:description> <maml:para>Specifies the resource pool where the VM should be cloned.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VmFolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmFolderId</maml:name> <maml:description> <maml:para>Specifies the folder where the VM should be cloned. This is applicable only when the VM is being cloned to an alternate location.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewParentId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewParentId</maml:name> <maml:description> <maml:para>Specifies a new parent source such as vCenter to clone the VM. If not specified, the VM is cloned to its original parent source.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Copy-CohesityVMwareVM -TaskName "test-clone-task" -SourceId 883 -TargetViewName "test-vm-datastore" -JobId 49402 -VmNamePrefix "clone-" -DisableNetwork -PoweredOn -ResourcePoolId 893</dev:code> <dev:remarks> <maml:para>Clones the VMware virtual machine with the given source id using the latest run of job id 49402.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CohesityVMwareVM --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CohesityVMwareVM</command:name> <command:verb>Get</command:verb> <command:noun>CohesityVMwareVM</command:noun> <maml:description> <maml:para>Gets a list of the VMware virtual machines known to the Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityVMwareVM</maml:name> <!-- Parameter: Names --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Names</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ParentSourceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ParentSourceId</maml:name> <maml:description> <maml:para>Limit the VMs returned to the set of VMs found in a specific parent source (such as vCenter Server).</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Protected --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Protected</maml:name> <maml:description> <maml:para>Limit the returned VMs to those that have been protected by a protection job.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Unprotected --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Unprotected</maml:name> <maml:description> <maml:para>Limit the returned VMs to those that are not protected by any protection job.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Uuids --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Uuids</maml:name> <maml:description> <maml:para>Limit the returned VMs to those that exactly match the passed in Uuids.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ParentSourceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ParentSourceId</maml:name> <maml:description> <maml:para>Limit the VMs returned to the set of VMs found in a specific parent source (such as vCenter Server).</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Names --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Names</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Uuids --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Uuids</maml:name> <maml:description> <maml:para>Limit the returned VMs to those that exactly match the passed in Uuids.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Protected --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Protected</maml:name> <maml:description> <maml:para>Limit the returned VMs to those that have been protected by a protection job.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Unprotected --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Unprotected</maml:name> <maml:description> <maml:para>Limit the returned VMs to those that are not protected by any protection job.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ProtectionSource --> <command:returnValue> <dev:type> <maml:name>Cohesity.Model.ProtectionSource</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Get-CohesityVMwareVM -ParentSourceId 2</dev:code> <dev:remarks> <maml:para>Gets a list of the virtual machines belonging to the vCenter Server with the ParentSourceId of 2.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Dismount-CohesityVolume --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Dismount-CohesityVolume</command:name> <command:verb>Dismount</command:verb> <command:noun>CohesityVolume</command:noun> <maml:description> <maml:para>Removes or tears down Cohesity instant mount volumes.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes or tears down the Cohesity instant mount volumes created by the specified task id.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Dismount-CohesityVolume</maml:name> <!-- Parameter: TaskId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the task id that created the instant mount volumes to be removed.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TaskId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the task id that created the instant mount volumes to be removed.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the task id that created the instant mount volumes to be removed.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Dismount-CohesityVolume -TaskId 1234</dev:code> <dev:remarks> <maml:para>Tears down the Cohesity instant mount volumes created by task id 1234.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Mount-CohesityVolume --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Mount-CohesityVolume</command:name> <command:verb>Mount</command:verb> <command:noun>CohesityVolume</command:noun> <maml:description> <maml:para>Mounts the specified volumes instantly to a target host from a previous backup.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Mounts the specified volumes instantly to a target host from a previous backup.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Mount-CohesityVolume</maml:name> <!-- Parameter: JobId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the job id to be used for this instant volume mount.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SourceId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceId</maml:name> <maml:description> <maml:para>Specifies the source id that was backed up.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: TaskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>Specifies the name of the instant volume mount task.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BringDisksOnline --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BringDisksOnline</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: JobRunId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobRunId</maml:name> <maml:description> <maml:para>Specifies the job run id to be used for this instant volume mount. If not specified the latest run is used.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewParentId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewParentId</maml:name> <maml:description> <maml:para>Specifies a new registered parent Protection Source. If not specified, the original parent source will be used.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetHostCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetHostCredential</maml:name> <maml:description> <maml:para>User credentials for accessing the target host for mounting the volumes.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetHostId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetHostId</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VolumeNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VolumeNames</maml:name> <maml:description> <maml:para>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:'</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TaskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>Specifies the name of the instant volume mount task.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceId</maml:name> <maml:description> <maml:para>Specifies the source id that was backed up.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: JobId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the job id to be used for this instant volume mount.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: JobRunId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobRunId</maml:name> <maml:description> <maml:para>Specifies the job run id to be used for this instant volume mount. If not specified the latest run is used.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BringDisksOnline --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BringDisksOnline</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NewParentId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewParentId</maml:name> <maml:description> <maml:para>Specifies a new registered parent Protection Source. If not specified, the original parent source will be used.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetHostId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetHostId</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetHostCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetHostCredential</maml:name> <maml:description> <maml:para>User credentials for accessing the target host for mounting the volumes.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VolumeNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VolumeNames</maml:name> <maml:description> <maml:para>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:'</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>PS></maml:para> </maml:introduction> <dev:code>Mount-CohesityVolume -TaskName "Test-Mount" -SourceId 12 -JobId 8 -BringDisksOnline -TargetHostId 23 -TargetHostCredential (Get-Credential)</dev:code> <dev:remarks> <maml:para>Mounts the volumes corresponding to the given source id to the given target host id using the latest run of job id 8.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> </helpItems> |