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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</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.Models.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.Models.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.Models.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">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> </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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</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.Models.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.Models.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.Models.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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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.Models.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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</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">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> </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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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.Models.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: 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.Models.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: 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: __AllParameterSets --> <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.</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> </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: 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.</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 /> <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: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.Models.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.Models.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.Models.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.Models.Cluster</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Cohesity.Models.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.Models.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>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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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.Models.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> <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> <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> </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: 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</maml:para> </maml:description> <command:parameterValue required="true">TargetHostTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.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: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</maml:para> </maml:description> <command:parameterValue required="true">TargetHostTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.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: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> </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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</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.Models.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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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">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 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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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.Models.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">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 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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: FileSearchResult --> <command:returnValue> <dev:type> <maml:name>Cohesity.Models.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: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: 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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</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.Models.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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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.Models.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">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 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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ObjectSnapshotInfo --> <command:returnValue> <dev:type> <maml:name>Cohesity.Models.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.Models.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.Models.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: Get-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>Get-CohesityProtectionJob</command:name> <command:verb>Get</command:verb> <command:noun>CohesityProtectionJob</command:noun> <maml:description> <maml:para>Gets a list of protection jobs filtered by the specified parameters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If no parameters are specified, all protection jobs (both active and inactive) on the Cohesity Cluster are returned. Note that the deleted protection jobs are not returned, by default. You may specify the OnlyDeleted parameter to get the deleted protection jobs. Specifying parameters filters the results that are returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityProtectionJob</maml:name> <!-- 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, kPuppeteer, kPhysical, kPure, kNetapp, kGenericNas, kHyperV, kAcropolis, kAzure. Only jobs protecting the specified environment types are returned. NOTE: kPuppeteer refers to Cohesity's remote adapter.</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.EnvironmentEnum[]</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 protection job ids.</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: 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 protection job 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: OnlyActive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnlyActive</maml:name> <maml:description> <maml:para>If set, only the active jobs are returned.</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: OnlyDeleted --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnlyDeleted</maml:name> <maml:description> <maml:para>If set, return only the deleted jobs that still have snapshots associated with them. If not set, the deleted jobs are not returned.</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: OnlyInactive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnlyInactive</maml:name> <maml:description> <maml:para>If set, only the inactive jobs are returned.</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: PolicyIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PolicyIds</maml:name> <maml:description> <maml:para>Filter by policy ids that are associated with protection jobs. Only jobs associated with the specified policy ids, are returned.</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 protection job ids.</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: 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 protection job 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: PolicyIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PolicyIds</maml:name> <maml:description> <maml:para>Filter by policy ids that are associated with protection jobs. Only jobs associated with the specified policy ids, are returned.</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: 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, kPuppeteer, kPhysical, kPure, kNetapp, kGenericNas, kHyperV, kAcropolis, kAzure. Only jobs protecting the specified environment types are returned. NOTE: kPuppeteer refers to Cohesity's remote adapter.</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.EnvironmentEnum[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OnlyActive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnlyActive</maml:name> <maml:description> <maml:para>If set, only the active jobs are returned.</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: OnlyInactive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnlyInactive</maml:name> <maml:description> <maml:para>If set, only the inactive jobs are returned.</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: OnlyDeleted --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnlyDeleted</maml:name> <maml:description> <maml:para>If set, return only the deleted jobs that still have snapshots associated with them. If not set, the deleted jobs are not returned.</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: ProtectionJob --> <command:returnValue> <dev:type> <maml:name>Cohesity.Models.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>Get-CohesityProtectionJob -Names Test-Job</dev:code> <dev:remarks> <maml:para>Gets the protection job with name "Test-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>Get-CohesityProtectionJob -OnlyActive</dev:code> <dev:remarks> <maml:para>Gets only the active protection jobs on the Cohesity Cluster.</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-CohesityProtectionJob -OnlyDeleted</dev:code> <dev:remarks> <maml:para>Gets only the deleted protection jobs on the Cohesity Cluster.</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: 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: 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, kAzure, kNetapp, kAgent, kGenericNas, kAcropolis, kPhysicalFiles, kIsilon, kKVM, kAWS, kExchange, kHyperVVSS, kOracle, kGCP, kFlashBlade, kAWSNative, kVCD, kO365, kO365Outlook, kHyperFlex, kGCPNative</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.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">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">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">kVCD</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:parameterValueGroup> </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: 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>10/18/2018 7:48:33 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> <command:parameterValue required="true">SourceSpecialParameter[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.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> </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: 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: 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, kAzure, kNetapp, kAgent, kGenericNas, kAcropolis, kPhysicalFiles, kIsilon, kKVM, kAWS, kExchange, kHyperVVSS, kOracle, kGCP, kFlashBlade, kAWSNative, kVCD, kO365, kO365Outlook, kHyperFlex, kGCPNative</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.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">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">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">kVCD</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:parameterValueGroup> </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: 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>10/18/2018 7:48:33 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> <command:parameterValue required="true">SourceSpecialParameter[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.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> </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: 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>10/18/2018 7:48:33 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: 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, kAzure, kNetapp, kAgent, kGenericNas, kAcropolis, kPhysicalFiles, kIsilon, kKVM, kAWS, kExchange, kHyperVVSS, kOracle, kGCP, kFlashBlade, kAWSNative, kVCD, kO365, kO365Outlook, kHyperFlex, kGCPNative</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.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">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">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">kVCD</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:parameterValueGroup> </command:parameter> <!-- Parameter: SourceSpecialParameters --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceSpecialParameters</maml:name> <command:parameterValue required="true">SourceSpecialParameter[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.SourceSpecialParameter[]</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.Models.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: Set-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>Set-CohesityProtectionJob</command:name> <command:verb>Set</command:verb> <command:noun>CohesityProtectionJob</command:noun> <maml:description> <maml:para>Updates a protection job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the updated protection job.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-CohesityProtectionJob</maml:name> <!-- Parameter: ProtectionJob --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ProtectionJob</maml:name> <maml:description> <maml:para>The updated protection job.</maml:para> </maml:description> <command:parameterValue required="true">ProtectionJob</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.ProtectionJob</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ProtectionJob --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ProtectionJob</maml:name> <maml:description> <maml:para>The updated protection job.</maml:para> </maml:description> <command:parameterValue required="true">ProtectionJob</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.ProtectionJob</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Cohesity.Models.ProtectionJob</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The updated protection job.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ProtectionJob --> <command:returnValue> <dev:type> <maml:name>Cohesity.Models.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>Set-CohesityProtectionJob -ProtectionJob $job</dev:code> <dev:remarks> <maml:para>Updates a protection job with the specified parameters.</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: 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.Models.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">Nullable`1[]</command:parameterValue> <dev:type> <maml:name>System.Nullable`1[[System.Int64, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]][]</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: 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.Models.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">Nullable`1[]</command:parameterValue> <dev:type> <maml:name>System.Nullable`1[[System.Int64, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]][]</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.Models.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">Nullable`1[]</command:parameterValue> <dev:type> <maml:name>System.Nullable`1[[System.Int64, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]][]</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: Stop-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>Stop-CohesityProtectionJob</command:name> <command:verb>Stop</command:verb> <command:noun>CohesityProtectionJob</command:noun> <maml:description> <maml:para>Cancels a running protection job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Stop-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: JobRunId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobRunId</maml:name> <maml:description> <maml:para>Run Id of a protection job run that needs to be cancelled. If this run id does not match the id of an active run in the protection job, the job run is not cancelled and an error will be returned. If this is not specified, the last job run id 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> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Stop-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: JobRunId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobRunId</maml:name> <maml:description> <maml:para>Run Id of a protection job run that needs to be cancelled. If this run id does not match the id of an active run in the protection job, the job run is not cancelled and an error will be returned. If this is not specified, the last job run id 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> </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: JobRunId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobRunId</maml:name> <maml:description> <maml:para>Run Id of a protection job run that needs to be cancelled. If this run id does not match the id of an active run in the protection job, the job run is not cancelled and an error will be returned. If this is not specified, the last job run id 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> </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>Stop-CohesityProtectionJob -Id 78773 -JobRunId 85510</dev:code> <dev:remarks> <maml:para>Cancels a running protection job with Id 78773 and JobRunId 85510.</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: Get-CohesityProtectionJobRun --> <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-CohesityProtectionJobRun</command:name> <command:verb>Get</command:verb> <command:noun>CohesityProtectionJobRun</command:noun> <maml:description> <maml:para>Gets a list of protection job runs filtered by the specified parameters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If no parameters are specified, all the job runs on the Cohesity Cluster are returned. Specifying parameters filters the results that are returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityProtectionJobRun</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 a end time specified as a unix epoch timestamp (in microseconds). Only job runs that completed before the specified end time 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: ExcludeErrorRuns --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeErrorRuns</maml:name> <maml:description> <maml:para>Filter out job runs with errors by setting this field. If not set, job runs with errors are returned.</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: ExcludeNonRestoreableRuns --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeNonRestoreableRuns</maml:name> <maml:description> <maml:para>Filter out jobs runs that cannot be restored by setting this field. If not set, runs without any successful object will be returned.</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: ExcludeTasks --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeTasks</maml:name> <maml:description> <maml:para>If true, the individual backup status for all the objects protected by the job run are not populated in the response. For example in a VMware environment, the status of backing up each VM associated with a job is not returned.</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: IncludeDeleted --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeDeleted</maml:name> <maml:description> <maml:para>Include jobs runs for deleted jobs by setting this field. If not set, runs for deleted jobs will not be returned.</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: JobId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Filter by a protection job that is specified by id. If not specified, all job runs for all protection jobs 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: JobName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobName</maml:name> <maml:description> <maml:para>Filter by a protection job that is specified by name. If not specified, all job runs for all protection jobs are returned.</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: NumRuns --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NumRuns</maml:name> <maml:description> <maml:para>Specify the number of job runs to return. The newest job runs 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: RunTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunTypes</maml:name> <maml:description> <maml:para>Filter by run type such as "kFull", "kRegular" or "kLog". If not specified, job runs of all types are returned.</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceId</maml:name> <maml:description> <maml:para>Filter by source id. Only job runs protecting the specified source (such as a VM or View) are returned. The source id is assigned by 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: StartedTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartedTime</maml:name> <maml:description> <maml:para>Return a specific job run by specifying a time and a jobId. Specify the time when the job run started as a unix epoch timestamp (in microseconds). If this field is specified, JobId must also be 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: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Filter by a start time. Only job runs that started after the specified time are returned. Specify the start time as a unix epoch 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: JobId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Filter by a protection job that is specified by id. If not specified, all job runs for all protection jobs 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: JobName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JobName</maml:name> <maml:description> <maml:para>Filter by a protection job that is specified by name. If not specified, all job runs for all protection jobs are returned.</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: StartedTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartedTime</maml:name> <maml:description> <maml:para>Return a specific job run by specifying a time and a jobId. Specify the time when the job run started as a unix epoch timestamp (in microseconds). If this field is specified, JobId must also be 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: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Filter by a start time. Only job runs that started after the specified time are returned. Specify the start time as a unix epoch 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> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Filter by a end time specified as a unix epoch timestamp (in microseconds). Only job runs that completed before the specified end time 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: NumRuns --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NumRuns</maml:name> <maml:description> <maml:para>Specify the number of job runs to return. The newest job runs 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: ExcludeTasks --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeTasks</maml:name> <maml:description> <maml:para>If true, the individual backup status for all the objects protected by the job run are not populated in the response. For example in a VMware environment, the status of backing up each VM associated with a job is not returned.</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: SourceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceId</maml:name> <maml:description> <maml:para>Filter by source id. Only job runs protecting the specified source (such as a VM or View) are returned. The source id is assigned by 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: ExcludeErrorRuns --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeErrorRuns</maml:name> <maml:description> <maml:para>Filter out job runs with errors by setting this field. If not set, job runs with errors are returned.</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: RunTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunTypes</maml:name> <maml:description> <maml:para>Filter by run type such as "kFull", "kRegular" or "kLog". If not specified, job runs of all types are returned.</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: ExcludeNonRestoreableRuns --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeNonRestoreableRuns</maml:name> <maml:description> <maml:para>Filter out jobs runs that cannot be restored by setting this field. If not set, runs without any successful object will be returned.</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: IncludeDeleted --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeDeleted</maml:name> <maml:description> <maml:para>Include jobs runs for deleted jobs by setting this field. If not set, runs for deleted jobs will not be returned.</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: ProtectionRunInstance --> <command:returnValue> <dev:type> <maml:name>Cohesity.Models.ProtectionRunInstance</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-CohesityProtectionJobRun -SourceId 2</dev:code> <dev:remarks> <maml:para>Only job runs protecting the specified source Id are returned.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-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>Get-CohesityProtectionPolicy</command:name> <command:verb>Get</command:verb> <command:noun>CohesityProtectionPolicy</command:noun> <maml:description> <maml:para>Gets a list of protection policies filtered by specified parameters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If no parameters are specified, all protection policies on the Cohesity Cluster are returned. Specifying parameters filters the results that are returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityProtectionPolicy</maml:name> <!-- Parameter: Environments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environments</maml:name> <maml:description> <maml:para>Filter by Environment type. Only Policies protecting the specified environment type are returned. NOTE: "kPuppeteer" refers to Cohesity’s Remote Adapter.</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.EnvironmentEnum[]</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 protection policy 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: 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 protection policy 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: Environments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environments</maml:name> <maml:description> <maml:para>Filter by Environment type. Only Policies protecting the specified environment type are returned. NOTE: "kPuppeteer" refers to Cohesity’s Remote Adapter.</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.EnvironmentEnum[]</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 protection policy 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: 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 protection policy 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: ProtectionPolicy --> <command:returnValue> <dev:type> <maml:name>Cohesity.Models.ProtectionPolicy</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-CohesityProtectionPolicy -Names Test-Policy</dev:code> <dev:remarks> <maml:para>Displays the protection policy with name "Test-Policy".</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: Set-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>Set-CohesityProtectionPolicy</command:name> <command:verb>Set</command:verb> <command:noun>CohesityProtectionPolicy</command:noun> <maml:description> <maml:para>Updates a Protection Policy.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the updated Protection Policy.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-CohesityProtectionPolicy</maml:name> <!-- Parameter: ProtectionPolicy --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ProtectionPolicy</maml:name> <maml:description> <maml:para>The updated Protection Policy object.</maml:para> </maml:description> <command:parameterValue required="true">ProtectionPolicy</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.ProtectionPolicy</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ProtectionPolicy --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ProtectionPolicy</maml:name> <maml:description> <maml:para>The updated Protection Policy object.</maml:para> </maml:description> <command:parameterValue required="true">ProtectionPolicy</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.ProtectionPolicy</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Cohesity.Models.ProtectionPolicy</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The updated Protection Policy object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ProtectionPolicy --> <command:returnValue> <dev:type> <maml:name>Cohesity.Models.ProtectionPolicy</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-CohesityProtectionPolicy -ProtectionPolicy $policy</dev:code> <dev:remarks> <maml:para>Updates a Protection Policy with the specified parameters.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-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>Get-CohesityProtectionSource</command:name> <command:verb>Get</command:verb> <command:noun>CohesityProtectionSource</command:noun> <maml:description> <maml:para>Gets a list of the registered protection sources filtered by the specified parameters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If no parameters are specified, all protection sources that are registered on the Cohesity Cluster are returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityProtectionSource</maml:name> <!-- Parameter: Environments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environments</maml:name> <maml:description> <maml:para>Return only protection sources that match the passed in environment type. For example, set this parameter to ‘kVMware’ to only return the VMware sources.</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.EnvironmentEnum[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Return only the protection source that matches the 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> </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>Return only protection sources that match the passed in environment type. For example, set this parameter to ‘kVMware’ to only return the VMware sources.</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.EnvironmentEnum[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Return only the protection source that matches the 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> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ProtectionSourceNode --> <command:returnValue> <dev:type> <maml:name>Cohesity.Models.ProtectionSourceNode</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-CohesityProtectionSource -Environments kVMware</dev:code> <dev:remarks> <maml:para>Returns registered protection sources that match the environment type 'kVMware’.</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.Models.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.Models.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.Models.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.Models.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.Models.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.Models.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> </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> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ProtectionSource --> <command:returnValue> <dev:type> <maml:name>Cohesity.Models.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-CohesityProtectionSourceHyperV --> <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-CohesityProtectionSourceHyperV</command:name> <command:verb>Register</command:verb> <command:noun>CohesityProtectionSourceHyperV</command:noun> <maml:description> <maml:para>Registers a new HyperV protection source with the Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Registers a new HyperV protection source with the Cohesity Cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Register-CohesityProtectionSourceHyperV</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 SCVMM server.</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 SCVMM 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 for the SCVMM 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: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>User credentials for the SCVMM server.</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.Models.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-CohesityProtectionSourceHyperV -Server scvmm.example.com -Credential (Get-Credential)</dev:code> <dev:remarks> <maml:para>Registers a new SCVMM server with hostname "scvmm.example.com" with the Cohesity Cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Register-CohesityProtectionSourceIsilon --> <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-CohesityProtectionSourceIsilon</command:name> <command:verb>Register</command:verb> <command:noun>CohesityProtectionSourceIsilon</command:noun> <maml:description> <maml:para>Registers a new Isilon protection source with the Cohesity Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Registers a new Isilon protection source with the Cohesity Cluster.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Register-CohesityProtectionSourceIsilon</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 Isilon 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 Isilon 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> </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 Isilon 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 Isilon 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> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ProtectionSource --> <command:returnValue> <dev:type> <maml:name>Cohesity.Models.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-CohesityProtectionSourceIsilon -Server isilon-cluster.example.com -Credential (Get-Credential)</dev:code> <dev:remarks> <maml:para>Registers a new Isilon cluster with hostname "isilon-cluster.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.Models.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, KVolume</maml:para> </maml:description> <command:parameterValue required="true">NetappTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.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:parameterValue required="false" variableLength="false">KVolume</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, KVolume</maml:para> </maml:description> <command:parameterValue required="true">NetappTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.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:parameterValue required="false" variableLength="false">KVolume</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ProtectionSource --> <command:returnValue> <dev:type> <maml:name>Cohesity.Models.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.Models.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: Get-CohesityProtectionSourceObject --> <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-CohesityProtectionSourceObject</command:name> <command:verb>Get</command:verb> <command:noun>CohesityProtectionSourceObject</command:noun> <maml:description> <maml:para>Gets a list of the registered Protection Sources and their sub objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If no parameters are specified, all the Protection Sources and their sub objects are returned. Specifying additional parameters can filter the results that are returned. If you only want to get a specific object you can specify the -Id parameter.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityProtectionSourceObject</maml:name> <!-- Parameter: Environments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environments</maml:name> <maml:description> <maml:para>Return only Protection Sources that match the passed in environment type. For example, set this parameter to ‘kVMware’ to only return the Sources (and their sub objects) found in the VMware environment.</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.EnvironmentEnum[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeTypes</maml:name> <maml:description> <maml:para>Filter out the Object types (and their sub objects) that match the passed in types. For example, set this parameter to "kResourcePool" to exclude Resource Pool Objects from being returned.</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: Id --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Returns only the object specified by the 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: IncludeDatastores --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeDatastores</maml:name> <maml:description> <maml:para>Set this parameter to also return kDatastore type of objects. By default, datastores are not returned.</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: IncludeNetworks --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeNetworks</maml:name> <maml:description> <maml:para>Set this parameter to also return kNetwork type of objects. By default, network objects are not returned.</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: IncludeVMFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeVMFolders</maml:name> <maml:description> <maml:para>Set this parameter to also return kVMFolder type of objects. By default, VM folder objects are not returned.</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: IncludeDatastores --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeDatastores</maml:name> <maml:description> <maml:para>Set this parameter to also return kDatastore type of objects. By default, datastores are not returned.</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: IncludeNetworks --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeNetworks</maml:name> <maml:description> <maml:para>Set this parameter to also return kNetwork type of objects. By default, network objects are not returned.</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: IncludeVMFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeVMFolders</maml:name> <maml:description> <maml:para>Set this parameter to also return kVMFolder type of objects. By default, VM folder objects are not returned.</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: Environments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environments</maml:name> <maml:description> <maml:para>Return only Protection Sources that match the passed in environment type. For example, set this parameter to ‘kVMware’ to only return the Sources (and their sub objects) found in the VMware environment.</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentEnum[]</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.EnvironmentEnum[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Returns only the object specified by the 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: ExcludeTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeTypes</maml:name> <maml:description> <maml:para>Filter out the Object types (and their sub objects) that match the passed in types. For example, set this parameter to "kResourcePool" to exclude Resource Pool Objects from being returned.</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>Returns only the object specified by the id.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ProtectionSource --> <command:returnValue> <dev:type> <maml:name>Cohesity.Models.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-CohesityProtectionSourceObject -Environments kPhysical</dev:code> <dev:remarks> <maml:para>Returns all the registered protection sources and their sub objects that match the environment type 'kPhysical’.</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-CohesityProtectionSourceObject -Id 1234</dev:code> <dev:remarks> <maml:para>Returns only the object that matches the specified id.</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, KOther</maml:para> </maml:description> <command:parameterValue required="true">HostTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.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">KOther</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, KWindowsCluster</maml:para> </maml:description> <command:parameterValue required="true">PhysicalTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.RegisterProtectionSourceParameters+PhysicalTypeEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KHost</command:parameterValue> <command:parameterValue required="false" variableLength="false">KWindowsCluster</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, KOther</maml:para> </maml:description> <command:parameterValue required="true">HostTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.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">KOther</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, KWindowsCluster</maml:para> </maml:description> <command:parameterValue required="true">PhysicalTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.RegisterProtectionSourceParameters+PhysicalTypeEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">KHost</command:parameterValue> <command:parameterValue required="false" variableLength="false">KWindowsCluster</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ProtectionSource --> <command:returnValue> <dev:type> <maml:name>Cohesity.Models.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.Models.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> </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> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ProtectionSource --> <command:returnValue> <dev:type> <maml:name>Cohesity.Models.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, KFolder, KDatacenter, KComputeResource, KClusterComputeResource, KResourcePool, KDatastore, KHostSystem, KVirtualMachine, KVirtualApp, KStandaloneHost, KStoragePod, KNetwork, KDistributedVirtualPortgroup, KTagCategory, KTag</maml:para> </maml:description> <command:parameterValue required="true">VmwareTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.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">KFolder</command:parameterValue> <command:parameterValue required="false" variableLength="false">KDatacenter</command:parameterValue> <command:parameterValue required="false" variableLength="false">KComputeResource</command:parameterValue> <command:parameterValue required="false" variableLength="false">KClusterComputeResource</command:parameterValue> <command:parameterValue required="false" variableLength="false">KResourcePool</command:parameterValue> <command:parameterValue required="false" variableLength="false">KDatastore</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHostSystem</command:parameterValue> <command:parameterValue required="false" variableLength="false">KVirtualMachine</command:parameterValue> <command:parameterValue required="false" variableLength="false">KVirtualApp</command:parameterValue> <command:parameterValue required="false" variableLength="false">KStandaloneHost</command:parameterValue> <command:parameterValue required="false" variableLength="false">KStoragePod</command:parameterValue> <command:parameterValue required="false" variableLength="false">KNetwork</command:parameterValue> <command:parameterValue required="false" variableLength="false">KDistributedVirtualPortgroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">KTagCategory</command:parameterValue> <command:parameterValue required="false" variableLength="false">KTag</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, KFolder, KDatacenter, KComputeResource, KClusterComputeResource, KResourcePool, KDatastore, KHostSystem, KVirtualMachine, KVirtualApp, KStandaloneHost, KStoragePod, KNetwork, KDistributedVirtualPortgroup, KTagCategory, KTag</maml:para> </maml:description> <command:parameterValue required="true">VmwareTypeEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.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">KFolder</command:parameterValue> <command:parameterValue required="false" variableLength="false">KDatacenter</command:parameterValue> <command:parameterValue required="false" variableLength="false">KComputeResource</command:parameterValue> <command:parameterValue required="false" variableLength="false">KClusterComputeResource</command:parameterValue> <command:parameterValue required="false" variableLength="false">KResourcePool</command:parameterValue> <command:parameterValue required="false" variableLength="false">KDatastore</command:parameterValue> <command:parameterValue required="false" variableLength="false">KHostSystem</command:parameterValue> <command:parameterValue required="false" variableLength="false">KVirtualMachine</command:parameterValue> <command:parameterValue required="false" variableLength="false">KVirtualApp</command:parameterValue> <command:parameterValue required="false" variableLength="false">KStandaloneHost</command:parameterValue> <command:parameterValue required="false" variableLength="false">KStoragePod</command:parameterValue> <command:parameterValue required="false" variableLength="false">KNetwork</command:parameterValue> <command:parameterValue required="false" variableLength="false">KDistributedVirtualPortgroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">KTagCategory</command:parameterValue> <command:parameterValue required="false" variableLength="false">KTag</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.Models.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-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.Models.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.Models.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.Models.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.Models.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: __AllParameterSets --> <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">Nullable`1[]</command:parameterValue> <dev:type> <maml:name>System.Nullable`1[[System.Int64, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]][]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- 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">Nullable`1[]</command:parameterValue> <dev:type> <maml:name>System.Nullable`1[[System.Int64, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]][]</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>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: Set-CohesitySnapshotRetention --> <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-CohesitySnapshotRetention</command:name> <command:verb>Set</command:verb> <command:noun>CohesitySnapshotRetention</command:noun> <maml:description> <maml:para>Changes the retention of the snapshots associated with a Protection Job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns success if the retention for snapshots is updated successfully.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ExtendRetention --> <command:syntaxItem> <maml:name>Set-CohesitySnapshotRetention</maml:name> <!-- Parameter: ExtendByDays --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ExtendByDays</maml:name> <maml:description> <maml:para>Specifies the number of days by which the Snapshot retention will be extended.</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: 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 select snapshots belonging to these source ids.</maml:para> </maml:description> <command:parameterValue required="true">Nullable`1[]</command:parameterValue> <dev:type> <maml:name>System.Nullable`1[[System.Int64, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]][]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ReduceRetention --> <command:syntaxItem> <maml:name>Set-CohesitySnapshotRetention</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: ReduceByDays --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ReduceByDays</maml:name> <maml:description> <maml:para>Specifies the number of days by which the Snapshot retention will be reduced.</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>Specifies the source ids to only select snapshots belonging to these source ids.</maml:para> </maml:description> <command:parameterValue required="true">Nullable`1[]</command:parameterValue> <dev:type> <maml:name>System.Nullable`1[[System.Int64, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]][]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- 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: ExtendByDays --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ExtendByDays</maml:name> <maml:description> <maml:para>Specifies the number of days by which the Snapshot retention will be extended.</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: ReduceByDays --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ReduceByDays</maml:name> <maml:description> <maml:para>Specifies the number of days by which the Snapshot retention will be reduced.</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>Specifies the source ids to only select snapshots belonging to these source ids.</maml:para> </maml:description> <command:parameterValue required="true">Nullable`1[]</command:parameterValue> <dev:type> <maml:name>System.Nullable`1[[System.Int64, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]][]</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>Set-CohesitySnapshotRetention -JobName Test-Job -JobRunId 2123 -ExtendByDays 30</dev:code> <dev:remarks> <maml:para>Extends the retention of the snapshots associated with the specified Protection Job and Job Run Id by 30 days.</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>Set-CohesitySnapshotRetention -JobName Test-Job -JobRunId 2123 -ReduceByDays 30</dev:code> <dev:remarks> <maml:para>Reduces the retention of the snapshots associated with the specified Protection Job and Job Run Id by 30 days.</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>Set-CohesitySnapshotRetention -JobName Test-Job -JobRunId 2123 -ExtendByDays 30 -SourceIds 883</dev:code> <dev:remarks> <maml:para>Extends the retention of the snapshots associated with only the specified Source Id (such as a VM), Protection Job and Job Run Id by 30 days.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CohesityStorageDomain --> <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-CohesityStorageDomain</command:name> <command:verb>Get</command:verb> <command:noun>CohesityStorageDomain</command:noun> <maml:description> <maml:para>Gets a list of storage domains (view boxes) filtered by the specified parameters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If no parameters are specified, all storage domains (view boxes) on the Cohesity Cluster are returned. Specifying parameters filters the results that are returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CohesityStorageDomain</maml:name> <!-- Parameter: ClusterPartitionIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClusterPartitionIds</maml:name> <maml:description> <maml:para>Filter by a list of cluster partition Ids.</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: FetchStats --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FetchStats</maml:name> <maml:description> <maml:para>Specifies whether to include usage and performance 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: 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 storage domain (view box) ids. If empty, view boxes are not filtered by id.</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: 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 storage domain (view box) names. If empty, storage domains(view boxes) are not filtered by name.</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 storage domain (view box) ids. If empty, view boxes are not filtered by id.</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: 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 storage domain (view box) names. If empty, storage domains(view boxes) are not filtered by name.</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: ClusterPartitionIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClusterPartitionIds</maml:name> <maml:description> <maml:para>Filter by a list of cluster partition Ids.</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: FetchStats --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FetchStats</maml:name> <maml:description> <maml:para>Specifies whether to include usage and performance 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: ViewBox --> <command:returnValue> <dev:type> <maml:name>Cohesity.Models.ViewBox</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-CohesityStorageDomain -Names Test-Domain</dev:code> <dev:remarks> <maml:para>Returns the storage domain that matches the name "Test-Domain".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CohesityStorageDomain --> <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-CohesityStorageDomain</command:name> <command:verb>Set</command:verb> <command:noun>CohesityStorageDomain</command:noun> <maml:description> <maml:para>Updates a Storage Domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the updated Storage Domain.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-CohesityStorageDomain</maml:name> <!-- Parameter: StorageDomain --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>StorageDomain</maml:name> <maml:description> <maml:para>The updated StorageDomain.</maml:para> </maml:description> <command:parameterValue required="true">ViewBox</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.ViewBox</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: StorageDomain --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>StorageDomain</maml:name> <maml:description> <maml:para>The updated StorageDomain.</maml:para> </maml:description> <command:parameterValue required="true">ViewBox</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.ViewBox</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Cohesity.Models.ViewBox</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The updated StorageDomain.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ViewBox --> <command:returnValue> <dev:type> <maml:name>Cohesity.Models.ViewBox</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-CohesityStorageDomain -StorageDomain $domain</dev:code> <dev:remarks> <maml:para>Updates a Storage Domain.</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> <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> <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> </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.Models.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>10/18/2018 7:48:33 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>10/18/2018 7:48:33 PM</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: User --> <command:returnValue> <dev:type> <maml:name>Cohesity.Models.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: Copy-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>Copy-CohesityView</command:name> <command:verb>Copy</command:verb> <command:noun>CohesityView</command:noun> <maml:description> <maml:para>Clones the specified Cohesity View.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Clones the specified Cohesity View.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Copy-CohesityView</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 View 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: SourceViewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceViewName</maml:name> <maml:description> <maml:para>Specifies the name of the View to clone.</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: TargetViewDescription --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetViewDescription</maml:name> <maml:description> <maml:para>Specifies the description of the cloned 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: 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 cloned 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: 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: 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 View. 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: QoSPolicy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QoSPolicy</maml:name> <maml:description> <maml:para>Specifies the name of the QoS Policy used for the cloned View such as 'TestAndDev High’, 'Backup Target SSD’, ‘Backup Target High’ ‘TestAndDev Low’ and 'Backup Target Low’. 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: 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> </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: SourceViewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceViewName</maml:name> <maml:description> <maml:para>Specifies the name of the View to clone.</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 cloned 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: QoSPolicy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QoSPolicy</maml:name> <maml:description> <maml:para>Specifies the name of the QoS Policy used for the cloned View such as 'TestAndDev High’, 'Backup Target SSD’, ‘Backup Target High’ ‘TestAndDev Low’ and 'Backup Target Low’. 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: TargetViewDescription --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetViewDescription</maml:name> <maml:description> <maml:para>Specifies the description of the cloned 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: 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 View 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 View. 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> </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-CohesityView -TaskName "clone-view-task" -SourceViewName "test-view" -TargetViewName "clone-of-test-view" -QosPolicy "Backup Target Low" -JobId 49402</dev:code> <dev:remarks> <maml:para>Clones the Cohesity View called "test-view" 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-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: 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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: View --> <command:returnValue> <dev:type> <maml:name>Cohesity.Models.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, KUnknown</maml:para> </maml:description> <command:parameterValue required="true">ProtocolAccessEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.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">KUnknown</command:parameterValue> </command:parameterValueGroup> </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: 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, KUnknown</maml:para> </maml:description> <command:parameterValue required="true">ProtocolAccessEnum</command:parameterValue> <dev:type> <maml:name>Cohesity.Models.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">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: 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.Models.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.Models.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.Models.View</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Cohesity.Models.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.Models.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: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.Models.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: Restore-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>Restore-CohesityVMwareVM</command:name> <command:verb>Restore</command:verb> <command:noun>CohesityVMwareVM</command:noun> <maml:description> <maml:para>Restores the specified VMware virtual machine from a previous backup.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Restores the specified VMware virtual machine from a previous backup.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Restore-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 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: DatastoreId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatastoreId</maml:name> <maml:description> <maml:para>Specifies the datastore where the VM should be recovered. This field is mandatory when recovering the VM to a different resource pool or to a different parent source such as vCenter. If not specified, VM is recovered to its original datastore location in the 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: 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: 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 recovered VM. By default, original network configuration is preserved if the VM is recovered under the same parent source and the same resource pool. Original network configuration is detached if the VM is recovered 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 recover the VM. If not specified, the VM is recovered 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 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: ResourcePoolId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourcePoolId</maml:name> <maml:description> <maml:para>Specifies the resource pool where the VM should be recovered. This field is mandatory if recovering to a new parent source such as vCenter. If this field is not specified, VM is recovered to the original 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: 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 restored. This is applicable only when the VM is being restored 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 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> <!-- Parameter: DatastoreId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatastoreId</maml:name> <maml:description> <maml:para>Specifies the datastore where the VM should be recovered. This field is mandatory when recovering the VM to a different resource pool or to a different parent source such as vCenter. If not specified, VM is recovered to its original datastore location in the 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: 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 recovered VM. By default, original network configuration is preserved if the VM is recovered under the same parent source and the same resource pool. Original network configuration is detached if the VM is recovered 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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourcePoolId</maml:name> <maml:description> <maml:para>Specifies the resource pool where the VM should be recovered. This field is mandatory if recovering to a new parent source such as vCenter. If this field is not specified, VM is recovered to the original 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: 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 restored. This is applicable only when the VM is being restored 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 recover the VM. If not specified, the VM is recovered 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>Restore-CohesityVMwareVM -TaskName "Test-Restore" -SourceId 2 -JobId 8 -VmNamePrefix "copy-" -DisableNetwork -PoweredOn</dev:code> <dev:remarks> <maml:para>Restores the VMware 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> </helpItems> |