en-US/Nutanix.Prism.PS.Cmds.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Cluster</command:name> <command:verb>Get</command:verb> <command:noun>Cluster</command:noun> <maml:description> <maml:para>Displays cluster info registered to the prism central. If multiple prism centrals are connected, all clusters under the connected prism centrals ar e displayed.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Displays Cluster name, UUID and hostname of the connected Prism Central.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Cluster</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Cluster name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-Cluster</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Cluster UUID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Cluster name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Cluster UUID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-Cluster</dev:code> <dev:remarks> <maml:para>Displays all the cluster registered for the connected Prism Central.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-Cluster mycluster</dev:code> <dev:remarks> <maml:para>Displays the cluster info of name mycluster</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-Cluster 0005bade-af08-c5ec-0000-000000019dda</dev:code> <dev:remarks> <maml:para>Displays the cluster info of the cluster with uuid 0005bade-af08-c5ec-0000-000000019dda. The first parameter can be either cluster name or UUID</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Image</command:name> <command:verb>Get</command:verb> <command:noun>Image</command:noun> <maml:description> <maml:para>Displays the image information of specified UUID.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If -ImageId is given, displays the information of the specific image, otherwise, displays all images from the Prism Central. Any images that are adde d directly from Prism Element will not be displayed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Image</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ImageId</maml:name> <maml:description> <maml:para>Image UUID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeVmDiskId</maml:name> <maml:description> <maml:para>Displays vm_disk_id which can be used for cloning VM. For example, you can create VMDiskAddress object then assign vm_disk_id to vmdisk_uuid property of VMDiskAddress</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ImageId</maml:name> <maml:description> <maml:para>Image UUID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeVmDiskId</maml:name> <maml:description> <maml:para>Displays vm_disk_id which can be used for cloning VM. For example, you can create VMDiskAddress object then assign vm_disk_id to vmdisk_uuid property of VMDiskAddress</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-Image -ImageId 452f17c2-c1fb-46a8-bbec-2eb914b9b425</dev:code> <dev:remarks> <maml:para>Displays the image information of UUID 452f17c2-c1fb-46a8-bbec-2eb914b9b425.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-Image -ImageId 452f17c2-c1fb-46a8-bbec-2eb914b9b425 | ConvertTo-Json -Depth 3</dev:code> <dev:remarks> <maml:para>Displays more details about the image in JSON format</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Metric</command:name> <command:verb>Get</command:verb> <command:noun>Metric</command:noun> <maml:description> <maml:para>Displays a metric of the cluster for given time period.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Displays a metric of the cluster for given time period. To list all available metrics, try `Get-Help Get-Metric -Parameter Metrics`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Metric</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>Cluster Name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>Metrics</maml:name> <maml:description> <maml:para>Metrics name. Available metrics name are \ // Number of IO.\ num_io </maml:para> <maml:para> // Number of read IO. \ num_read_io </maml:para> <maml:para> // Number of random IO. \ num_random_io </maml:para> <maml:para> // Total IO size. \ total_io_size_kbytes </maml:para> <maml:para> // Total read IO size.\ total_read_io_size_kbytes </maml:para> <maml:para> // Total IO time. For example, if there are 2 IOs, each of them takes\ // 1 msecs. The total_io_time_usecs is 2000 usecs.\ total_io_time_usecs </maml:para> <maml:para> // Total read IO time. For example, if there are 2 IOs, each of them takes 1\ // msecs. The total_io_time_usecs is 2000 usecs.\ total_read_io_time_usecs </maml:para> <maml:para> // The time span which the stats is recorded. For example, if stargate is\ // sending data once very 10s, timespan is 10,000,000 usecs.\ timespan_usecs </maml:para> <maml:para> // Transformed space usage is bytes after transformation (like compression,\ // encryption etc).\ total_transformed_usage_bytes </maml:para> <maml:para> // Transformed space usage before transformation.\ total_untransformed_usage_bytes </maml:para> <maml:para> // The time span over which the stats reported by the Hypervisor are\ // recorded.\ hypervisor_timespan_usecs </maml:para> <maml:para> // Total number of reads and writes as reported by the Hypervisor.\ hypervisor_num_io </maml:para> <maml:para> // Number of reads as reported by the Hypervisor.\ hypervisor_num_read_io </maml:para> <maml:para> // Total IO size (reads and writes) as reported by the Hypervisor.\ hypervisor_total_io_size_kbytes </maml:para> <maml:para> // Total read IO size on a virtual disk as reported by the Hypervisor.\ hypervisor_total_read_io_size_kbytes </maml:para> <maml:para> // Total IO time (for the reads and writes) as reported by the Hypervisor.\ hypervisor_total_io_time_usecs </maml:para> <maml:para> // Total read IO time as reported by the Hypervisor.\ hypervisor_total_read_io_time_usecs </maml:para> <maml:para> // Number of IO.\ controller_num_io </maml:para> <maml:para> // Number of read IO.\ controller_num_read_io </maml:para> <maml:para> // Number of random IO.\ controller_num_random_io </maml:para> <maml:para> // Total IO size.\ controller_total_io_size_kbytes </maml:para> <maml:para> // Total read IO size.\ controller_total_read_io_size_kbytes </maml:para> <maml:para> // Total IO time. For example, if there are 2 IOs, each of them takes\ // 1 msecs. The total_io_time_usecs is 2000 usecs.\ controller_total_io_time_usecs </maml:para> <maml:para> // Total read IO time. For example, if there are 2 IOs, each of them takes 1\ // msecs. The total_io_time_usecs is 2000 usecs.\ controller_total_read_io_time_usecs </maml:para> <maml:para> // The time span which the stats is recorded. For example, if stargate is\ // sending data once very 10s, timespan is 10,000,000 usecs.\ controller_timespan_usecs </maml:para> <maml:para> // Transformed space usage is bytes after transformation (like compression,\ // encryption etc).\ controller_total_transformed_usage_bytes </maml:para> <maml:para> // Average read i/o size.\ controller_avg_read_io_size_kbytes </maml:para> <maml:para> // Average write i/o size.\ controller_avg_write_io_size_kbytes </maml:para> <maml:para> // Number of write IO.\ num_write_io </maml:para> <maml:para> // Number of sequential IO.\ num_seq_io </maml:para> <maml:para> // Number of IO per second.\ num_iops </maml:para> <maml:para> // IO bandwidth - KB per second.\ io_bandwidth_kBps </maml:para> <maml:para> // Average IO latency.\ avg_io_latency_usecs </maml:para> <maml:para> // Average read IO latency. This is not available for VDisk, Disk, Node,\ // StoragePool and Cluster since Stargate does not have the stats.\ avg_read_io_latency_usecs </maml:para> <maml:para> // Read IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ read_io_ppm </maml:para> <maml:para> // Write IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ write_io_ppm </maml:para> <maml:para> // Random IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ random_io_ppm </maml:para> <maml:para> // Sequential IO percentage expressed in parts per million. To get\ // percentage, the value should be divided by 1 million and multipled\ // by 100.\ seq_io_ppm </maml:para> <maml:para>\ \ / Hypervisor derived stats /</maml:para> <maml:para> // Number of writes as reported by the Hypervisor.\ hypervisor_num_write_io </maml:para> <maml:para> // Number of IO per second as reported by the Hypervisor.\ hypervisor_num_iops </maml:para> <maml:para> // IO bandwidth - KB per second as reported by the Hypervisor.\ hypervisor_io_bandwidth_kBps </maml:para> <maml:para> // Average IO latency as reported by the Hypervisor.\ hypervisor_avg_io_latency_usecs </maml:para> <maml:para> // Average read IO latency as reproted by the Hypervisor.\ hypervisor_avg_read_io_latency_usecs </maml:para> <maml:para> // Number of read IO per second.\ num_read_iops </maml:para> <maml:para> // Number of write IO per second.\ num_write_iops </maml:para> <maml:para> // Average read IO latency. This is not available for VDisk, Disk, Node,\ // StoragePool and Cluster since Stargate does not have the stats.\ avg_write_io_latency_usecs </maml:para> <maml:para> // Number of read operations per second as reported by the Hypervisor.\ hypervisor_num_read_iops </maml:para> <maml:para> // Number of write operations per second as reported by the Hypervisor.\ hypervisor_num_write_iops </maml:para> <maml:para> // Average write operation latency as reported by the Hypervisor.\ hypervisor_avg_write_io_latency_usecs </maml:para> <maml:para> // Number of read write IO per second reported by the Hypervisor.\ hypervisor_read_io_bandwidth_kBps </maml:para> <maml:para> // Number of write write IO per second reported by the Hypervisor.\ hypervisor_write_io_bandwidth_kBps</maml:para> <maml:para>\ \ / Controller derived stats /</maml:para> <maml:para> // Number of write IO.\ controller_num_write_io </maml:para> <maml:para> // Number of sequential IO.\ controller_num_seq_io </maml:para> <maml:para> // Number of IO per second.\ controller_num_iops </maml:para> <maml:para> // IO bandwidth - KB per second.\ controller_io_bandwidth_kBps </maml:para> <maml:para> // Average IO latency.\ controller_avg_io_latency_usecs </maml:para> <maml:para> // Average read IO latency. This is not available for VDisk, Disk, Node,\ // StoragePool and Cluster since Stargate does not have the stats.\ controller_avg_read_io_latency_usecs </maml:para> <maml:para> // Read IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ controller_read_io_ppm </maml:para> <maml:para> // Write IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ controller_write_io_ppm </maml:para> <maml:para> // Random IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ controller_random_io_ppm </maml:para> <maml:para> // Sequential IO percentage expressed in parts per million. To get\ // percentage, the value should be divided by 1 million and multipled\ // by 100.\ controller_seq_io_ppm </maml:para> <maml:para> // Number of read IO per second.\ controller_num_read_iops </maml:para> <maml:para> // Number of write IO per second.\ controller_num_write_iops </maml:para> <maml:para> // Average read IO latency. This is not available for VDisk, Disk, Node,\ // StoragePool and Cluster since Stargate does not have the stats.\ controller_avg_write_io_latency_usecs </maml:para> <maml:para> // Number of storage controller read IO per second reported by Stargate.\ controller_read_io_bandwidth_kBps </maml:para> <maml:para> // Number of storage controller write IO per second reported by Stargate.\ controller_write_io_bandwidth_kBps </maml:para> <maml:para> // Number of disk read IO per second reported by Stargate.\ read_io_bandwidth_kBps </maml:para> <maml:para> // Number of disk write IO per second reported by Stargate.\ write_io_bandwidth_kBps</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>EndTimeSecsAgo</maml:name> <maml:description> <maml:para>End time of the metric</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>IntervalInSecs</maml:name> <maml:description> <maml:para>Interval of the metric in range of 1 to 300</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>StartTimeSecsAgo</maml:name> <maml:description> <maml:para>Start time of the metric</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-Metric</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>Cluster Name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>Metrics</maml:name> <maml:description> <maml:para>Metrics name. Available metrics name are \ // Number of IO.\ num_io </maml:para> <maml:para> // Number of read IO. \ num_read_io </maml:para> <maml:para> // Number of random IO. \ num_random_io </maml:para> <maml:para> // Total IO size. \ total_io_size_kbytes </maml:para> <maml:para> // Total read IO size.\ total_read_io_size_kbytes </maml:para> <maml:para> // Total IO time. For example, if there are 2 IOs, each of them takes\ // 1 msecs. The total_io_time_usecs is 2000 usecs.\ total_io_time_usecs </maml:para> <maml:para> // Total read IO time. For example, if there are 2 IOs, each of them takes 1\ // msecs. The total_io_time_usecs is 2000 usecs.\ total_read_io_time_usecs </maml:para> <maml:para> // The time span which the stats is recorded. For example, if stargate is\ // sending data once very 10s, timespan is 10,000,000 usecs.\ timespan_usecs </maml:para> <maml:para> // Transformed space usage is bytes after transformation (like compression,\ // encryption etc).\ total_transformed_usage_bytes </maml:para> <maml:para> // Transformed space usage before transformation.\ total_untransformed_usage_bytes </maml:para> <maml:para> // The time span over which the stats reported by the Hypervisor are\ // recorded.\ hypervisor_timespan_usecs </maml:para> <maml:para> // Total number of reads and writes as reported by the Hypervisor.\ hypervisor_num_io </maml:para> <maml:para> // Number of reads as reported by the Hypervisor.\ hypervisor_num_read_io </maml:para> <maml:para> // Total IO size (reads and writes) as reported by the Hypervisor.\ hypervisor_total_io_size_kbytes </maml:para> <maml:para> // Total read IO size on a virtual disk as reported by the Hypervisor.\ hypervisor_total_read_io_size_kbytes </maml:para> <maml:para> // Total IO time (for the reads and writes) as reported by the Hypervisor.\ hypervisor_total_io_time_usecs </maml:para> <maml:para> // Total read IO time as reported by the Hypervisor.\ hypervisor_total_read_io_time_usecs </maml:para> <maml:para> // Number of IO.\ controller_num_io </maml:para> <maml:para> // Number of read IO.\ controller_num_read_io </maml:para> <maml:para> // Number of random IO.\ controller_num_random_io </maml:para> <maml:para> // Total IO size.\ controller_total_io_size_kbytes </maml:para> <maml:para> // Total read IO size.\ controller_total_read_io_size_kbytes </maml:para> <maml:para> // Total IO time. For example, if there are 2 IOs, each of them takes\ // 1 msecs. The total_io_time_usecs is 2000 usecs.\ controller_total_io_time_usecs </maml:para> <maml:para> // Total read IO time. For example, if there are 2 IOs, each of them takes 1\ // msecs. The total_io_time_usecs is 2000 usecs.\ controller_total_read_io_time_usecs </maml:para> <maml:para> // The time span which the stats is recorded. For example, if stargate is\ // sending data once very 10s, timespan is 10,000,000 usecs.\ controller_timespan_usecs </maml:para> <maml:para> // Transformed space usage is bytes after transformation (like compression,\ // encryption etc).\ controller_total_transformed_usage_bytes </maml:para> <maml:para> // Average read i/o size.\ controller_avg_read_io_size_kbytes </maml:para> <maml:para> // Average write i/o size.\ controller_avg_write_io_size_kbytes </maml:para> <maml:para> // Number of write IO.\ num_write_io </maml:para> <maml:para> // Number of sequential IO.\ num_seq_io </maml:para> <maml:para> // Number of IO per second.\ num_iops </maml:para> <maml:para> // IO bandwidth - KB per second.\ io_bandwidth_kBps </maml:para> <maml:para> // Average IO latency.\ avg_io_latency_usecs </maml:para> <maml:para> // Average read IO latency. This is not available for VDisk, Disk, Node,\ // StoragePool and Cluster since Stargate does not have the stats.\ avg_read_io_latency_usecs </maml:para> <maml:para> // Read IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ read_io_ppm </maml:para> <maml:para> // Write IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ write_io_ppm </maml:para> <maml:para> // Random IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ random_io_ppm </maml:para> <maml:para> // Sequential IO percentage expressed in parts per million. To get\ // percentage, the value should be divided by 1 million and multipled\ // by 100.\ seq_io_ppm </maml:para> <maml:para>\ \ / Hypervisor derived stats /</maml:para> <maml:para> // Number of writes as reported by the Hypervisor.\ hypervisor_num_write_io </maml:para> <maml:para> // Number of IO per second as reported by the Hypervisor.\ hypervisor_num_iops </maml:para> <maml:para> // IO bandwidth - KB per second as reported by the Hypervisor.\ hypervisor_io_bandwidth_kBps </maml:para> <maml:para> // Average IO latency as reported by the Hypervisor.\ hypervisor_avg_io_latency_usecs </maml:para> <maml:para> // Average read IO latency as reproted by the Hypervisor.\ hypervisor_avg_read_io_latency_usecs </maml:para> <maml:para> // Number of read IO per second.\ num_read_iops </maml:para> <maml:para> // Number of write IO per second.\ num_write_iops </maml:para> <maml:para> // Average read IO latency. This is not available for VDisk, Disk, Node,\ // StoragePool and Cluster since Stargate does not have the stats.\ avg_write_io_latency_usecs </maml:para> <maml:para> // Number of read operations per second as reported by the Hypervisor.\ hypervisor_num_read_iops </maml:para> <maml:para> // Number of write operations per second as reported by the Hypervisor.\ hypervisor_num_write_iops </maml:para> <maml:para> // Average write operation latency as reported by the Hypervisor.\ hypervisor_avg_write_io_latency_usecs </maml:para> <maml:para> // Number of read write IO per second reported by the Hypervisor.\ hypervisor_read_io_bandwidth_kBps </maml:para> <maml:para> // Number of write write IO per second reported by the Hypervisor.\ hypervisor_write_io_bandwidth_kBps</maml:para> <maml:para>\ \ / Controller derived stats /</maml:para> <maml:para> // Number of write IO.\ controller_num_write_io </maml:para> <maml:para> // Number of sequential IO.\ controller_num_seq_io </maml:para> <maml:para> // Number of IO per second.\ controller_num_iops </maml:para> <maml:para> // IO bandwidth - KB per second.\ controller_io_bandwidth_kBps </maml:para> <maml:para> // Average IO latency.\ controller_avg_io_latency_usecs </maml:para> <maml:para> // Average read IO latency. This is not available for VDisk, Disk, Node,\ // StoragePool and Cluster since Stargate does not have the stats.\ controller_avg_read_io_latency_usecs </maml:para> <maml:para> // Read IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ controller_read_io_ppm </maml:para> <maml:para> // Write IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ controller_write_io_ppm </maml:para> <maml:para> // Random IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ controller_random_io_ppm </maml:para> <maml:para> // Sequential IO percentage expressed in parts per million. To get\ // percentage, the value should be divided by 1 million and multipled\ // by 100.\ controller_seq_io_ppm </maml:para> <maml:para> // Number of read IO per second.\ controller_num_read_iops </maml:para> <maml:para> // Number of write IO per second.\ controller_num_write_iops </maml:para> <maml:para> // Average read IO latency. This is not available for VDisk, Disk, Node,\ // StoragePool and Cluster since Stargate does not have the stats.\ controller_avg_write_io_latency_usecs </maml:para> <maml:para> // Number of storage controller read IO per second reported by Stargate.\ controller_read_io_bandwidth_kBps </maml:para> <maml:para> // Number of storage controller write IO per second reported by Stargate.\ controller_write_io_bandwidth_kBps </maml:para> <maml:para> // Number of disk read IO per second reported by Stargate.\ read_io_bandwidth_kBps </maml:para> <maml:para> // Number of disk write IO per second reported by Stargate.\ write_io_bandwidth_kBps</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>IntervalInSecs</maml:name> <maml:description> <maml:para>Interval of the metric in range of 1 to 300</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-Metric</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ClusterUuid</maml:name> <maml:description> <maml:para>Cluster UUID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>Metrics</maml:name> <maml:description> <maml:para>Metrics name. Available metrics name are \ // Number of IO.\ num_io </maml:para> <maml:para> // Number of read IO. \ num_read_io </maml:para> <maml:para> // Number of random IO. \ num_random_io </maml:para> <maml:para> // Total IO size. \ total_io_size_kbytes </maml:para> <maml:para> // Total read IO size.\ total_read_io_size_kbytes </maml:para> <maml:para> // Total IO time. For example, if there are 2 IOs, each of them takes\ // 1 msecs. The total_io_time_usecs is 2000 usecs.\ total_io_time_usecs </maml:para> <maml:para> // Total read IO time. For example, if there are 2 IOs, each of them takes 1\ // msecs. The total_io_time_usecs is 2000 usecs.\ total_read_io_time_usecs </maml:para> <maml:para> // The time span which the stats is recorded. For example, if stargate is\ // sending data once very 10s, timespan is 10,000,000 usecs.\ timespan_usecs </maml:para> <maml:para> // Transformed space usage is bytes after transformation (like compression,\ // encryption etc).\ total_transformed_usage_bytes </maml:para> <maml:para> // Transformed space usage before transformation.\ total_untransformed_usage_bytes </maml:para> <maml:para> // The time span over which the stats reported by the Hypervisor are\ // recorded.\ hypervisor_timespan_usecs </maml:para> <maml:para> // Total number of reads and writes as reported by the Hypervisor.\ hypervisor_num_io </maml:para> <maml:para> // Number of reads as reported by the Hypervisor.\ hypervisor_num_read_io </maml:para> <maml:para> // Total IO size (reads and writes) as reported by the Hypervisor.\ hypervisor_total_io_size_kbytes </maml:para> <maml:para> // Total read IO size on a virtual disk as reported by the Hypervisor.\ hypervisor_total_read_io_size_kbytes </maml:para> <maml:para> // Total IO time (for the reads and writes) as reported by the Hypervisor.\ hypervisor_total_io_time_usecs </maml:para> <maml:para> // Total read IO time as reported by the Hypervisor.\ hypervisor_total_read_io_time_usecs </maml:para> <maml:para> // Number of IO.\ controller_num_io </maml:para> <maml:para> // Number of read IO.\ controller_num_read_io </maml:para> <maml:para> // Number of random IO.\ controller_num_random_io </maml:para> <maml:para> // Total IO size.\ controller_total_io_size_kbytes </maml:para> <maml:para> // Total read IO size.\ controller_total_read_io_size_kbytes </maml:para> <maml:para> // Total IO time. For example, if there are 2 IOs, each of them takes\ // 1 msecs. The total_io_time_usecs is 2000 usecs.\ controller_total_io_time_usecs </maml:para> <maml:para> // Total read IO time. For example, if there are 2 IOs, each of them takes 1\ // msecs. The total_io_time_usecs is 2000 usecs.\ controller_total_read_io_time_usecs </maml:para> <maml:para> // The time span which the stats is recorded. For example, if stargate is\ // sending data once very 10s, timespan is 10,000,000 usecs.\ controller_timespan_usecs </maml:para> <maml:para> // Transformed space usage is bytes after transformation (like compression,\ // encryption etc).\ controller_total_transformed_usage_bytes </maml:para> <maml:para> // Average read i/o size.\ controller_avg_read_io_size_kbytes </maml:para> <maml:para> // Average write i/o size.\ controller_avg_write_io_size_kbytes </maml:para> <maml:para> // Number of write IO.\ num_write_io </maml:para> <maml:para> // Number of sequential IO.\ num_seq_io </maml:para> <maml:para> // Number of IO per second.\ num_iops </maml:para> <maml:para> // IO bandwidth - KB per second.\ io_bandwidth_kBps </maml:para> <maml:para> // Average IO latency.\ avg_io_latency_usecs </maml:para> <maml:para> // Average read IO latency. This is not available for VDisk, Disk, Node,\ // StoragePool and Cluster since Stargate does not have the stats.\ avg_read_io_latency_usecs </maml:para> <maml:para> // Read IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ read_io_ppm </maml:para> <maml:para> // Write IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ write_io_ppm </maml:para> <maml:para> // Random IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ random_io_ppm </maml:para> <maml:para> // Sequential IO percentage expressed in parts per million. To get\ // percentage, the value should be divided by 1 million and multipled\ // by 100.\ seq_io_ppm </maml:para> <maml:para>\ \ / Hypervisor derived stats /</maml:para> <maml:para> // Number of writes as reported by the Hypervisor.\ hypervisor_num_write_io </maml:para> <maml:para> // Number of IO per second as reported by the Hypervisor.\ hypervisor_num_iops </maml:para> <maml:para> // IO bandwidth - KB per second as reported by the Hypervisor.\ hypervisor_io_bandwidth_kBps </maml:para> <maml:para> // Average IO latency as reported by the Hypervisor.\ hypervisor_avg_io_latency_usecs </maml:para> <maml:para> // Average read IO latency as reproted by the Hypervisor.\ hypervisor_avg_read_io_latency_usecs </maml:para> <maml:para> // Number of read IO per second.\ num_read_iops </maml:para> <maml:para> // Number of write IO per second.\ num_write_iops </maml:para> <maml:para> // Average read IO latency. This is not available for VDisk, Disk, Node,\ // StoragePool and Cluster since Stargate does not have the stats.\ avg_write_io_latency_usecs </maml:para> <maml:para> // Number of read operations per second as reported by the Hypervisor.\ hypervisor_num_read_iops </maml:para> <maml:para> // Number of write operations per second as reported by the Hypervisor.\ hypervisor_num_write_iops </maml:para> <maml:para> // Average write operation latency as reported by the Hypervisor.\ hypervisor_avg_write_io_latency_usecs </maml:para> <maml:para> // Number of read write IO per second reported by the Hypervisor.\ hypervisor_read_io_bandwidth_kBps </maml:para> <maml:para> // Number of write write IO per second reported by the Hypervisor.\ hypervisor_write_io_bandwidth_kBps</maml:para> <maml:para>\ \ / Controller derived stats /</maml:para> <maml:para> // Number of write IO.\ controller_num_write_io </maml:para> <maml:para> // Number of sequential IO.\ controller_num_seq_io </maml:para> <maml:para> // Number of IO per second.\ controller_num_iops </maml:para> <maml:para> // IO bandwidth - KB per second.\ controller_io_bandwidth_kBps </maml:para> <maml:para> // Average IO latency.\ controller_avg_io_latency_usecs </maml:para> <maml:para> // Average read IO latency. This is not available for VDisk, Disk, Node,\ // StoragePool and Cluster since Stargate does not have the stats.\ controller_avg_read_io_latency_usecs </maml:para> <maml:para> // Read IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ controller_read_io_ppm </maml:para> <maml:para> // Write IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ controller_write_io_ppm </maml:para> <maml:para> // Random IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ controller_random_io_ppm </maml:para> <maml:para> // Sequential IO percentage expressed in parts per million. To get\ // percentage, the value should be divided by 1 million and multipled\ // by 100.\ controller_seq_io_ppm </maml:para> <maml:para> // Number of read IO per second.\ controller_num_read_iops </maml:para> <maml:para> // Number of write IO per second.\ controller_num_write_iops </maml:para> <maml:para> // Average read IO latency. This is not available for VDisk, Disk, Node,\ // StoragePool and Cluster since Stargate does not have the stats.\ controller_avg_write_io_latency_usecs </maml:para> <maml:para> // Number of storage controller read IO per second reported by Stargate.\ controller_read_io_bandwidth_kBps </maml:para> <maml:para> // Number of storage controller write IO per second reported by Stargate.\ controller_write_io_bandwidth_kBps </maml:para> <maml:para> // Number of disk read IO per second reported by Stargate.\ read_io_bandwidth_kBps </maml:para> <maml:para> // Number of disk write IO per second reported by Stargate.\ write_io_bandwidth_kBps</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>EndTimeSecsAgo</maml:name> <maml:description> <maml:para>End time of the metric</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>IntervalInSecs</maml:name> <maml:description> <maml:para>Interval of the metric in range of 1 to 300</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>StartTimeSecsAgo</maml:name> <maml:description> <maml:para>Start time of the metric</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-Metric</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ClusterUuid</maml:name> <maml:description> <maml:para>Cluster UUID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>Metrics</maml:name> <maml:description> <maml:para>Metrics name. Available metrics name are \ // Number of IO.\ num_io </maml:para> <maml:para> // Number of read IO. \ num_read_io </maml:para> <maml:para> // Number of random IO. \ num_random_io </maml:para> <maml:para> // Total IO size. \ total_io_size_kbytes </maml:para> <maml:para> // Total read IO size.\ total_read_io_size_kbytes </maml:para> <maml:para> // Total IO time. For example, if there are 2 IOs, each of them takes\ // 1 msecs. The total_io_time_usecs is 2000 usecs.\ total_io_time_usecs </maml:para> <maml:para> // Total read IO time. For example, if there are 2 IOs, each of them takes 1\ // msecs. The total_io_time_usecs is 2000 usecs.\ total_read_io_time_usecs </maml:para> <maml:para> // The time span which the stats is recorded. For example, if stargate is\ // sending data once very 10s, timespan is 10,000,000 usecs.\ timespan_usecs </maml:para> <maml:para> // Transformed space usage is bytes after transformation (like compression,\ // encryption etc).\ total_transformed_usage_bytes </maml:para> <maml:para> // Transformed space usage before transformation.\ total_untransformed_usage_bytes </maml:para> <maml:para> // The time span over which the stats reported by the Hypervisor are\ // recorded.\ hypervisor_timespan_usecs </maml:para> <maml:para> // Total number of reads and writes as reported by the Hypervisor.\ hypervisor_num_io </maml:para> <maml:para> // Number of reads as reported by the Hypervisor.\ hypervisor_num_read_io </maml:para> <maml:para> // Total IO size (reads and writes) as reported by the Hypervisor.\ hypervisor_total_io_size_kbytes </maml:para> <maml:para> // Total read IO size on a virtual disk as reported by the Hypervisor.\ hypervisor_total_read_io_size_kbytes </maml:para> <maml:para> // Total IO time (for the reads and writes) as reported by the Hypervisor.\ hypervisor_total_io_time_usecs </maml:para> <maml:para> // Total read IO time as reported by the Hypervisor.\ hypervisor_total_read_io_time_usecs </maml:para> <maml:para> // Number of IO.\ controller_num_io </maml:para> <maml:para> // Number of read IO.\ controller_num_read_io </maml:para> <maml:para> // Number of random IO.\ controller_num_random_io </maml:para> <maml:para> // Total IO size.\ controller_total_io_size_kbytes </maml:para> <maml:para> // Total read IO size.\ controller_total_read_io_size_kbytes </maml:para> <maml:para> // Total IO time. For example, if there are 2 IOs, each of them takes\ // 1 msecs. The total_io_time_usecs is 2000 usecs.\ controller_total_io_time_usecs </maml:para> <maml:para> // Total read IO time. For example, if there are 2 IOs, each of them takes 1\ // msecs. The total_io_time_usecs is 2000 usecs.\ controller_total_read_io_time_usecs </maml:para> <maml:para> // The time span which the stats is recorded. For example, if stargate is\ // sending data once very 10s, timespan is 10,000,000 usecs.\ controller_timespan_usecs </maml:para> <maml:para> // Transformed space usage is bytes after transformation (like compression,\ // encryption etc).\ controller_total_transformed_usage_bytes </maml:para> <maml:para> // Average read i/o size.\ controller_avg_read_io_size_kbytes </maml:para> <maml:para> // Average write i/o size.\ controller_avg_write_io_size_kbytes </maml:para> <maml:para> // Number of write IO.\ num_write_io </maml:para> <maml:para> // Number of sequential IO.\ num_seq_io </maml:para> <maml:para> // Number of IO per second.\ num_iops </maml:para> <maml:para> // IO bandwidth - KB per second.\ io_bandwidth_kBps </maml:para> <maml:para> // Average IO latency.\ avg_io_latency_usecs </maml:para> <maml:para> // Average read IO latency. This is not available for VDisk, Disk, Node,\ // StoragePool and Cluster since Stargate does not have the stats.\ avg_read_io_latency_usecs </maml:para> <maml:para> // Read IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ read_io_ppm </maml:para> <maml:para> // Write IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ write_io_ppm </maml:para> <maml:para> // Random IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ random_io_ppm </maml:para> <maml:para> // Sequential IO percentage expressed in parts per million. To get\ // percentage, the value should be divided by 1 million and multipled\ // by 100.\ seq_io_ppm </maml:para> <maml:para>\ \ / Hypervisor derived stats /</maml:para> <maml:para> // Number of writes as reported by the Hypervisor.\ hypervisor_num_write_io </maml:para> <maml:para> // Number of IO per second as reported by the Hypervisor.\ hypervisor_num_iops </maml:para> <maml:para> // IO bandwidth - KB per second as reported by the Hypervisor.\ hypervisor_io_bandwidth_kBps </maml:para> <maml:para> // Average IO latency as reported by the Hypervisor.\ hypervisor_avg_io_latency_usecs </maml:para> <maml:para> // Average read IO latency as reproted by the Hypervisor.\ hypervisor_avg_read_io_latency_usecs </maml:para> <maml:para> // Number of read IO per second.\ num_read_iops </maml:para> <maml:para> // Number of write IO per second.\ num_write_iops </maml:para> <maml:para> // Average read IO latency. This is not available for VDisk, Disk, Node,\ // StoragePool and Cluster since Stargate does not have the stats.\ avg_write_io_latency_usecs </maml:para> <maml:para> // Number of read operations per second as reported by the Hypervisor.\ hypervisor_num_read_iops </maml:para> <maml:para> // Number of write operations per second as reported by the Hypervisor.\ hypervisor_num_write_iops </maml:para> <maml:para> // Average write operation latency as reported by the Hypervisor.\ hypervisor_avg_write_io_latency_usecs </maml:para> <maml:para> // Number of read write IO per second reported by the Hypervisor.\ hypervisor_read_io_bandwidth_kBps </maml:para> <maml:para> // Number of write write IO per second reported by the Hypervisor.\ hypervisor_write_io_bandwidth_kBps</maml:para> <maml:para>\ \ / Controller derived stats /</maml:para> <maml:para> // Number of write IO.\ controller_num_write_io </maml:para> <maml:para> // Number of sequential IO.\ controller_num_seq_io </maml:para> <maml:para> // Number of IO per second.\ controller_num_iops </maml:para> <maml:para> // IO bandwidth - KB per second.\ controller_io_bandwidth_kBps </maml:para> <maml:para> // Average IO latency.\ controller_avg_io_latency_usecs </maml:para> <maml:para> // Average read IO latency. This is not available for VDisk, Disk, Node,\ // StoragePool and Cluster since Stargate does not have the stats.\ controller_avg_read_io_latency_usecs </maml:para> <maml:para> // Read IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ controller_read_io_ppm </maml:para> <maml:para> // Write IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ controller_write_io_ppm </maml:para> <maml:para> // Random IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ controller_random_io_ppm </maml:para> <maml:para> // Sequential IO percentage expressed in parts per million. To get\ // percentage, the value should be divided by 1 million and multipled\ // by 100.\ controller_seq_io_ppm </maml:para> <maml:para> // Number of read IO per second.\ controller_num_read_iops </maml:para> <maml:para> // Number of write IO per second.\ controller_num_write_iops </maml:para> <maml:para> // Average read IO latency. This is not available for VDisk, Disk, Node,\ // StoragePool and Cluster since Stargate does not have the stats.\ controller_avg_write_io_latency_usecs </maml:para> <maml:para> // Number of storage controller read IO per second reported by Stargate.\ controller_read_io_bandwidth_kBps </maml:para> <maml:para> // Number of storage controller write IO per second reported by Stargate.\ controller_write_io_bandwidth_kBps </maml:para> <maml:para> // Number of disk read IO per second reported by Stargate.\ read_io_bandwidth_kBps </maml:para> <maml:para> // Number of disk write IO per second reported by Stargate.\ write_io_bandwidth_kBps</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>IntervalInSecs</maml:name> <maml:description> <maml:para>Interval of the metric in range of 1 to 300</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>Cluster Name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ClusterUuid</maml:name> <maml:description> <maml:para>Cluster UUID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>EndTimeSecsAgo</maml:name> <maml:description> <maml:para>End time of the metric</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>IntervalInSecs</maml:name> <maml:description> <maml:para>Interval of the metric in range of 1 to 300</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>Metrics</maml:name> <maml:description> <maml:para>Metrics name. Available metrics name are \ // Number of IO.\ num_io </maml:para> <maml:para> // Number of read IO. \ num_read_io </maml:para> <maml:para> // Number of random IO. \ num_random_io </maml:para> <maml:para> // Total IO size. \ total_io_size_kbytes </maml:para> <maml:para> // Total read IO size.\ total_read_io_size_kbytes </maml:para> <maml:para> // Total IO time. For example, if there are 2 IOs, each of them takes\ // 1 msecs. The total_io_time_usecs is 2000 usecs.\ total_io_time_usecs </maml:para> <maml:para> // Total read IO time. For example, if there are 2 IOs, each of them takes 1\ // msecs. The total_io_time_usecs is 2000 usecs.\ total_read_io_time_usecs </maml:para> <maml:para> // The time span which the stats is recorded. For example, if stargate is\ // sending data once very 10s, timespan is 10,000,000 usecs.\ timespan_usecs </maml:para> <maml:para> // Transformed space usage is bytes after transformation (like compression,\ // encryption etc).\ total_transformed_usage_bytes </maml:para> <maml:para> // Transformed space usage before transformation.\ total_untransformed_usage_bytes </maml:para> <maml:para> // The time span over which the stats reported by the Hypervisor are\ // recorded.\ hypervisor_timespan_usecs </maml:para> <maml:para> // Total number of reads and writes as reported by the Hypervisor.\ hypervisor_num_io </maml:para> <maml:para> // Number of reads as reported by the Hypervisor.\ hypervisor_num_read_io </maml:para> <maml:para> // Total IO size (reads and writes) as reported by the Hypervisor.\ hypervisor_total_io_size_kbytes </maml:para> <maml:para> // Total read IO size on a virtual disk as reported by the Hypervisor.\ hypervisor_total_read_io_size_kbytes </maml:para> <maml:para> // Total IO time (for the reads and writes) as reported by the Hypervisor.\ hypervisor_total_io_time_usecs </maml:para> <maml:para> // Total read IO time as reported by the Hypervisor.\ hypervisor_total_read_io_time_usecs </maml:para> <maml:para> // Number of IO.\ controller_num_io </maml:para> <maml:para> // Number of read IO.\ controller_num_read_io </maml:para> <maml:para> // Number of random IO.\ controller_num_random_io </maml:para> <maml:para> // Total IO size.\ controller_total_io_size_kbytes </maml:para> <maml:para> // Total read IO size.\ controller_total_read_io_size_kbytes </maml:para> <maml:para> // Total IO time. For example, if there are 2 IOs, each of them takes\ // 1 msecs. The total_io_time_usecs is 2000 usecs.\ controller_total_io_time_usecs </maml:para> <maml:para> // Total read IO time. For example, if there are 2 IOs, each of them takes 1\ // msecs. The total_io_time_usecs is 2000 usecs.\ controller_total_read_io_time_usecs </maml:para> <maml:para> // The time span which the stats is recorded. For example, if stargate is\ // sending data once very 10s, timespan is 10,000,000 usecs.\ controller_timespan_usecs </maml:para> <maml:para> // Transformed space usage is bytes after transformation (like compression,\ // encryption etc).\ controller_total_transformed_usage_bytes </maml:para> <maml:para> // Average read i/o size.\ controller_avg_read_io_size_kbytes </maml:para> <maml:para> // Average write i/o size.\ controller_avg_write_io_size_kbytes </maml:para> <maml:para> // Number of write IO.\ num_write_io </maml:para> <maml:para> // Number of sequential IO.\ num_seq_io </maml:para> <maml:para> // Number of IO per second.\ num_iops </maml:para> <maml:para> // IO bandwidth - KB per second.\ io_bandwidth_kBps </maml:para> <maml:para> // Average IO latency.\ avg_io_latency_usecs </maml:para> <maml:para> // Average read IO latency. This is not available for VDisk, Disk, Node,\ // StoragePool and Cluster since Stargate does not have the stats.\ avg_read_io_latency_usecs </maml:para> <maml:para> // Read IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ read_io_ppm </maml:para> <maml:para> // Write IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ write_io_ppm </maml:para> <maml:para> // Random IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ random_io_ppm </maml:para> <maml:para> // Sequential IO percentage expressed in parts per million. To get\ // percentage, the value should be divided by 1 million and multipled\ // by 100.\ seq_io_ppm </maml:para> <maml:para>\ \ / Hypervisor derived stats /</maml:para> <maml:para> // Number of writes as reported by the Hypervisor.\ hypervisor_num_write_io </maml:para> <maml:para> // Number of IO per second as reported by the Hypervisor.\ hypervisor_num_iops </maml:para> <maml:para> // IO bandwidth - KB per second as reported by the Hypervisor.\ hypervisor_io_bandwidth_kBps </maml:para> <maml:para> // Average IO latency as reported by the Hypervisor.\ hypervisor_avg_io_latency_usecs </maml:para> <maml:para> // Average read IO latency as reproted by the Hypervisor.\ hypervisor_avg_read_io_latency_usecs </maml:para> <maml:para> // Number of read IO per second.\ num_read_iops </maml:para> <maml:para> // Number of write IO per second.\ num_write_iops </maml:para> <maml:para> // Average read IO latency. This is not available for VDisk, Disk, Node,\ // StoragePool and Cluster since Stargate does not have the stats.\ avg_write_io_latency_usecs </maml:para> <maml:para> // Number of read operations per second as reported by the Hypervisor.\ hypervisor_num_read_iops </maml:para> <maml:para> // Number of write operations per second as reported by the Hypervisor.\ hypervisor_num_write_iops </maml:para> <maml:para> // Average write operation latency as reported by the Hypervisor.\ hypervisor_avg_write_io_latency_usecs </maml:para> <maml:para> // Number of read write IO per second reported by the Hypervisor.\ hypervisor_read_io_bandwidth_kBps </maml:para> <maml:para> // Number of write write IO per second reported by the Hypervisor.\ hypervisor_write_io_bandwidth_kBps</maml:para> <maml:para>\ \ / Controller derived stats /</maml:para> <maml:para> // Number of write IO.\ controller_num_write_io </maml:para> <maml:para> // Number of sequential IO.\ controller_num_seq_io </maml:para> <maml:para> // Number of IO per second.\ controller_num_iops </maml:para> <maml:para> // IO bandwidth - KB per second.\ controller_io_bandwidth_kBps </maml:para> <maml:para> // Average IO latency.\ controller_avg_io_latency_usecs </maml:para> <maml:para> // Average read IO latency. This is not available for VDisk, Disk, Node,\ // StoragePool and Cluster since Stargate does not have the stats.\ controller_avg_read_io_latency_usecs </maml:para> <maml:para> // Read IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ controller_read_io_ppm </maml:para> <maml:para> // Write IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ controller_write_io_ppm </maml:para> <maml:para> // Random IO percentage expressed in parts per million. To get percentage,\ // the value should be divided by 1 million and multipled by 100.\ controller_random_io_ppm </maml:para> <maml:para> // Sequential IO percentage expressed in parts per million. To get\ // percentage, the value should be divided by 1 million and multipled\ // by 100.\ controller_seq_io_ppm </maml:para> <maml:para> // Number of read IO per second.\ controller_num_read_iops </maml:para> <maml:para> // Number of write IO per second.\ controller_num_write_iops </maml:para> <maml:para> // Average read IO latency. This is not available for VDisk, Disk, Node,\ // StoragePool and Cluster since Stargate does not have the stats.\ controller_avg_write_io_latency_usecs </maml:para> <maml:para> // Number of storage controller read IO per second reported by Stargate.\ controller_read_io_bandwidth_kBps </maml:para> <maml:para> // Number of storage controller write IO per second reported by Stargate.\ controller_write_io_bandwidth_kBps </maml:para> <maml:para> // Number of disk read IO per second reported by Stargate.\ read_io_bandwidth_kBps </maml:para> <maml:para> // Number of disk write IO per second reported by Stargate.\ write_io_bandwidth_kBps</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>StartTimeSecsAgo</maml:name> <maml:description> <maml:para>Start time of the metric</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-Metric -Server 10.46.28.31 -ClusterName mycluster -Metrics controller_num_iops -StartTimeSecsAgo 600 -EndTimeSecsAgo 0 -IntervalInSecs 60</dev:code> <dev:remarks> <maml:para>Displays the metric controller_num_iops from 600 seconds ago till now with 60 seconds of interval from the cluster. To get cluster name use `Get-Cluster` command.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-Help Get-Metric -Parameter Metrics</dev:code> <dev:remarks> <maml:para>Displays all available metrics names</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Network</command:name> <command:verb>Get</command:verb> <command:noun>Network</command:noun> <maml:description> <maml:para>Displays all networks available for the connected Prism Central.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Displays all networks available for the connected Prism Central. This is typically used to get network UUID to attach to VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Network</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number of subnet to display</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Number of page to display</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number of subnet to display</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Number of page to display</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-Network</dev:code> <dev:remarks> <maml:para>Displays all available networks from connected Prism Central.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-StorageContainer</command:name> <command:verb>Get</command:verb> <command:noun>StorageContainer</command:noun> <maml:description> <maml:para>Displays storage containers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Displays storage containers available for the connected Prism Central. Typically used to get UUID of the storage container to attach to a VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-StorageContainer</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number of storage containers to display</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Number of page to display</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number of storage containers to display</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Number of page to display</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-StorageContainer</dev:code> <dev:remarks> <maml:para>Displays a list of available storage container for the connected Prism Central.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Task</command:name> <command:verb>Get</command:verb> <command:noun>Task</command:noun> <maml:description> <maml:para>Displays tasks.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Displays tasks for the connected Prism Central. Typically used to get status of running tasks. To get the task already completed, use `-IncludeComple ted`. To wait until the task is completed, append pipe followed by `Wait-Task`. Default task count value is 20.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Task</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Task UUID. If this UUID is given, it will display the task regardless it is completed or not, even though -IncludeCompleted is not given.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number of tasks to be displayed. Default is 20</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IncludeCompleted</maml:name> <maml:description> <maml:para>To include completed tasks. Default is false.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number of tasks to be displayed. Default is 20</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IncludeCompleted</maml:name> <maml:description> <maml:para>To include completed tasks. Default is false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Task UUID. If this UUID is given, it will display the task regardless it is completed or not, even though -IncludeCompleted is not given.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-Task</dev:code> <dev:remarks> <maml:para>Displays last 20 task that are running for each connected prism central. If there is no tasks currently running, nothing will be displayed.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-Task -IncludeCompleted</dev:code> <dev:remarks> <maml:para>Displays last 20 tasks that are completed. If `-Count` is given, displays the number of tasks specified by -Count.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VM</command:name> <command:verb>Get</command:verb> <command:noun>VM</command:noun> <maml:description> <maml:para>Displays a list of VM</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Displays a list of VM for the connected Prism Central.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VM</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Displays one or more VMs with the given name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>Name of cluster to search VMs from. If not given, it searches for all connected Prism Central or given Prism Central host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Contains</maml:name> <maml:description> <maml:para>Displays VMs that contains given name</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number of VMs to display</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SortCriteria</maml:name> <maml:description> <maml:para>Sorts by given criteria. Default is by name.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">vm_name</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">num_vcpus</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">memory_size_bytes</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VM</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Displays one or more VMs with the given name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>Name of cluster to search VMs from. If not given, it searches for all connected Prism Central or given Prism Central host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number of VMs to display</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SortCriteria</maml:name> <maml:description> <maml:para>Sorts by given criteria. Default is by name.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">vm_name</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">num_vcpus</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">memory_size_bytes</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StartsWith</maml:name> <maml:description> <maml:para>Displays VMs with the names starting with the given name.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VM</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Displays one or more VMs with the given name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>Name of cluster to search VMs from. If not given, it searches for all connected Prism Central or given Prism Central host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number of VMs to display</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndsWith</maml:name> <maml:description> <maml:para>Displays VMs with the names ending with the given name.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SortCriteria</maml:name> <maml:description> <maml:para>Sorts by given criteria. Default is by name.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">vm_name</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">num_vcpus</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">memory_size_bytes</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VM</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number of VMs to display</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PowerState</maml:name> <maml:description> <maml:para>Displays the VMs with given power state. Available state is ON or OFF</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">ON</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OFF</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SortCriteria</maml:name> <maml:description> <maml:para>Sorts by given criteria. Default is by name.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">vm_name</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">num_vcpus</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">memory_size_bytes</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VM</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number of VMs to display</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SortCriteria</maml:name> <maml:description> <maml:para>Sorts by given criteria. Default is by name.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">vm_name</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">num_vcpus</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">memory_size_bytes</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>UUID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>Name of cluster to search VMs from. If not given, it searches for all connected Prism Central or given Prism Central host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Contains</maml:name> <maml:description> <maml:para>Displays VMs that contains given name</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number of VMs to display</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndsWith</maml:name> <maml:description> <maml:para>Displays VMs with the names ending with the given name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Displays one or more VMs with the given name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PowerState</maml:name> <maml:description> <maml:para>Displays the VMs with given power state. Available state is ON or OFF</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SortCriteria</maml:name> <maml:description> <maml:para>Sorts by given criteria. Default is by name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StartsWith</maml:name> <maml:description> <maml:para>Displays VMs with the names starting with the given name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>UUID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-VM</dev:code> <dev:remarks> <maml:para>Displays all VMs for the connected Prism Central.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-VM testvm</dev:code> <dev:remarks> <maml:para>Displays all VMs with VM name `testvm`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-VM testvm -Contains</dev:code> <dev:remarks> <maml:para>Displays all VMs that contains the name as `testvm`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Get-VM testvm -StartsWith</dev:code> <dev:remarks> <maml:para>Displays all VMs with names starting with `testvm`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>PS C:\> Get-VM testvm -EndsWith</dev:code> <dev:remarks> <maml:para>Displays all VMs with names ending with `testvm`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <dev:code>PS C:\> Get-VM -PowerState ON</dev:code> <dev:remarks> <maml:para>Displays all VMs with power state is ON.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 7 --------------------------</maml:title> <dev:code>PS C:\> Get-VM -Count 10 -Page 2</dev:code> <dev:remarks> <maml:para>Displays 10 VMs from the second page</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-Image</command:name> <command:verb>New</command:verb> <command:noun>Image</command:noun> <maml:description> <maml:para>Creates a new image</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new image</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-Image</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>Cluster name to create the image in</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ImageType</maml:name> <maml:description> <maml:para>Image type. It can be either DISK_IMAGE or ISO_IMAGE</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">DISK_IMAGE</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ISO_IMAGE</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SourceUri</maml:name> <maml:description> <maml:para>Source Uri of the image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-Image</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ClusterUuid</maml:name> <maml:description> <maml:para>Cluster UUID to create the image in</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ImageType</maml:name> <maml:description> <maml:para>Image type. It can be either DISK_IMAGE or ISO_IMAGE</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">DISK_IMAGE</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ISO_IMAGE</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SourceUri</maml:name> <maml:description> <maml:para>Source Uri of the image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-Image</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ImageType</maml:name> <maml:description> <maml:para>Image type. It can be either DISK_IMAGE or ISO_IMAGE</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">DISK_IMAGE</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ISO_IMAGE</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SourceUri</maml:name> <maml:description> <maml:para>Source Uri of the image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>Cluster name to create the image in</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ClusterUuid</maml:name> <maml:description> <maml:para>Cluster UUID to create the image in</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ImageType</maml:name> <maml:description> <maml:para>Image type. It can be either DISK_IMAGE or ISO_IMAGE</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SourceUri</maml:name> <maml:description> <maml:para>Source Uri of the image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-Image -Name testimage1 -ClusterName mycluster -ImageType DISK_IMAGE -SourceUri http://image.upload.host.com/GoldImages/centoslight_run_fioboot.qcow2</dev:code> <dev:remarks> <maml:para>Creates a new image in cluster `mycluster`. -SourceUri is the source of the image from where the image should be picked to create New-Image.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-Image -Servers 10.46.28.27 -Name testimage1 -ImageType DISK_IMAGE -SourceUri http://image.upload.host.com/GoldImages/centoslight_run_fioboot.qcow2</dev:code> <dev:remarks> <maml:para>reates a new image on Prism Central 10.46.28.27. Prism Central will automatically select the available cluster and creates the image on it.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-VM</command:name> <command:verb>New</command:verb> <command:noun>VM</command:noun> <maml:description> <maml:para>Creates a New VM.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a New VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-VM</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>BootConfig</maml:name> <maml:description> <maml:para>BootConfig object to attach. Create using New-NutanixObject then assign values to each property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BootConfigDTO</command:parameterValue> <dev:type> <maml:name>BootConfigDTO</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>Name of the Cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the new VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>GuestOS</maml:name> <maml:description> <maml:para>The GuestOS affects the supported devices and number of virtual CPUs available for the VM. GuestOS if ignored if the cluster is AHV.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MemoryMb</maml:name> <maml:description> <maml:para>The size of memory of the VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>NumCoresPerVcpu</maml:name> <maml:description> <maml:para>Number of cores per Vcpu.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>NumVcpus</maml:name> <maml:description> <maml:para>Number of Vcpu.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>VmDisks</maml:name> <maml:description> <maml:para>List of disks cloned and attached.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMDiskDTO[]</command:parameterValue> <dev:type> <maml:name>VMDiskDTO[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>VmNics</maml:name> <maml:description> <maml:para>List of networks to be connected.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMNicSpecDTO[]</command:parameterValue> <dev:type> <maml:name>VMNicSpecDTO[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-VM</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>BootConfig</maml:name> <maml:description> <maml:para>BootConfig object to attach. Create using New-NutanixObject then assign values to each property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BootConfigDTO</command:parameterValue> <dev:type> <maml:name>BootConfigDTO</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ClusterUUID</maml:name> <maml:description> <maml:para>UUID of the Cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the new VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>GuestOS</maml:name> <maml:description> <maml:para>The GuestOS affects the supported devices and number of virtual CPUs available for the VM. GuestOS if ignored if the cluster is AHV.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MemoryMb</maml:name> <maml:description> <maml:para>The size of memory of the VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>NumCoresPerVcpu</maml:name> <maml:description> <maml:para>Number of cores per Vcpu.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>NumVcpus</maml:name> <maml:description> <maml:para>Number of Vcpu.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>VmDisks</maml:name> <maml:description> <maml:para>List of disks cloned and attached.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMDiskDTO[]</command:parameterValue> <dev:type> <maml:name>VMDiskDTO[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>VmNics</maml:name> <maml:description> <maml:para>List of networks to be connected.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMNicSpecDTO[]</command:parameterValue> <dev:type> <maml:name>VMNicSpecDTO[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>BootConfig</maml:name> <maml:description> <maml:para>BootConfig object to attach. Create using New-NutanixObject then assign values to each property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BootConfigDTO</command:parameterValue> <dev:type> <maml:name>BootConfigDTO</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>Name of the Cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ClusterUUID</maml:name> <maml:description> <maml:para>UUID of the Cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the new VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>GuestOS</maml:name> <maml:description> <maml:para>The GuestOS affects the supported devices and number of virtual CPUs available for the VM. GuestOS if ignored if the cluster is AHV.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MemoryMb</maml:name> <maml:description> <maml:para>The size of memory of the VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>NumCoresPerVcpu</maml:name> <maml:description> <maml:para>Number of cores per Vcpu.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>NumVcpus</maml:name> <maml:description> <maml:para>Number of Vcpu.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>VmDisks</maml:name> <maml:description> <maml:para>List of disks cloned and attached.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMDiskDTO[]</command:parameterValue> <dev:type> <maml:name>VMDiskDTO[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>VmNics</maml:name> <maml:description> <maml:para>List of networks to be connected.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMNicSpecDTO[]</command:parameterValue> <dev:type> <maml:name>VMNicSpecDTO[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Nutanix.Prism.DTO.Acropolis.VMDiskDTO[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Nutanix.Prism.DTO.Acropolis.VMNicSpecDTO[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Nutanix.Prism.DTO.Acropolis.BootConfigDTO</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-VM -Name testvm1 -ClusterName mycluster -NumVcpus 1 -MemoryMb 500 | Wait-Task</dev:code> <dev:remarks> <maml:para>Creates a VM with 1 VCPU and 500MB of memory on the cluster `mycluster` then wait until the task is finished.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Create $diskAddress PC C:\> $diskAddress=New-NutanixObject VMDiskAddress $diskAddress.device_bus='scsi' $diskAddress.device_index=0 Create $boot and assign the $diskAddress to $boot.disk_address PC C:\> $boot=New-NutanixObject BootConfig $boot.uefi_boot=$false $boot.boot_device_type='DISK' $boot.disk_address=$diskAddress If you want to create a Secure Boot use following BootConfig object PC C:\> $boot=New-NutanixObject BootConfig $boot.uefi_boot=$true $boot.secure_boot=$true $boot.boot_device_type='DISK' $boot.disk_address=$diskAddress Create $vmDiskCreate : use Get-StorageContainer | ConvertTo-Json -depth 6 and use UUID for the storage. Example UUID is for the container default-container-38910 PC C:\> $vmDiskCreate=New-NutanixObject VMDiskSpecCreate $vmDiskCreate.storage_container_uuid='9067f4d2-4671-4e55-b007-c5cd4524f55a' $vmDiskCreate.size=1073741824 Create $vmDisk and assign $vmDiskCreate to $vmDisk.vm_disk_create and assign $diskAddress to $vmDisk.disk_address PC C:\> $vmDisk=New-NutanixObject VMDisk $vmDisk.is_cdrom=$false $vmDisk.disk_address=$diskAddress $vmDisk.vm_disk_create=$vmDiskCreate Create $vmNic : use Get-Network | ConvertTo-Json -depth 6 and use UUID for the network. For Phase1, you need to create the network from UI PC C:\> $vmNic=New-NutanixObject VMNicSpec $vmNic.network_uuid='1856d8cc-e3d7-4c6f-97a3-2037c0baa2fb' $vmNic.is_connected=$true Create the VM using above objects and wait for the task PC C:\> New-VM -Name testvm2 -ClusterName mycluster -NumVcpus 1 -MemoryMb 500 -BootConfig $boot -VmDisks $vmDisk -VmNics $vmNic | Wait-Task</dev:code> <dev:remarks> <maml:para>Creates a new VM with disk, network and custom boot config. Use New-NutanixObject to create an object for the parameters then update each property as needed.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get the VM disk UUID PC C:\> Get-Image state : COMPLETE name : testimage1 description : uuid : 189641ef-0ea6-474d-86b0-d1106c2f643f retrieval_uri_list : {https://127.0.0.1:9440/api/nutanix/v3/images/189641ef-0ea6-474d-86b0-d1106c2f643f/file} architecture : X86_64 size_bytes : 2000000000 image_type : DISK_IMAGE source_uri : http://host_of_source/path_to_source/image.qcow2 vm_disk_id : host : 10.36.240.22 Get the VM Disk UUID of the Image using -IncludeVMDiskId option along with -ImageId PC C:\> Get-Image -ImageId 189641ef-0ea6-474d-86b0-d1106c2f643f -IncludeVmDiskId state : name : testimage1 description : uuid : 189641ef-0ea6-474d-86b0-d1106c2f643f retrieval_uri_list : architecture : size_bytes : 2000000000 image_type : DISK_IMAGE source_uri : vm_disk_id : 2b1afdc8-62aa-43f5-9353-cda86d90cc5a host : Create VMDiskAddress object using the VM Disk UUID from above PS C:\> $cloneDiskAddress=New-NutanixObject VMDiskAddress PS C:\> $cloneDiskAddress.vmdisk_uuid='2b1afdc8-62aa-43f5-9353-cda86d90cc5a' Create VMDiskSpecClone object and assign the disk address object. PS C:\> $vmDiskClone=New-NutanixObject VMDiskSpecClone PS C:\> $vmDiskClone.disk_address=$cloneDiskAddress Create VMDisk object and assign the object to vm_disk_clone property PS C:\> $vmDisk=New-NutanixObject VMDisk PS C:\> $vmDisk.is_cdrom=$false PS C:\> $vmDisk.vm_disk_clone=$vmDiskClone Create a new VM using the disk clone from above. PC C:\>New-VM -Name testvmclone1 -ClusterName mycluster -NumVcpus 1 -MemoryMb 500 -VmDisks $vmDisk | Wait-Task</dev:code> <dev:remarks> <maml:para>Creates a new VM by cloning disk from an image.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-Image</command:name> <command:verb>Remove</command:verb> <command:noun>Image</command:noun> <maml:description> <maml:para>Removes an image.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes an image. If `-Servers` is not given, it will look for all connected Prism Central and find the image then removes it.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-Image</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ImageId</maml:name> <maml:description> <maml:para>Image UUID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ImageId</maml:name> <maml:description> <maml:para>Image UUID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-Image -ImageId 25a2a7dc-cf26-4cb7-8bfb-f103fdfcd2d1 | Wait-Task</dev:code> <dev:remarks> <maml:para>Removes the image with UUID 25a2a7dc-cf26-4cb7-8bfb-f103fdfcd2d1 and wait for the task to be completed.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VM</command:name> <command:verb>Remove</command:verb> <command:noun>VM</command:noun> <maml:description> <maml:para>Removes a VM</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a VM. If `-Server` is not given, it will look for all connected Prism Central and removes it.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VM</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>UUID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>UUID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-VM 5b25f68b-fe73-4cdc-88bf-a5485dff1627</dev:code> <dev:remarks> <maml:para>Find the UUID from connected Prism Central and removes it.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Remove-VM -Server 10.46.28.27 5b25f68b-fe73-4cdc-88bf-a5485dff1627</dev:code> <dev:remarks> <maml:para>Find the UUID from Prism Central 10.46.28.27 then removes it. It will remove only if the VM is in the Prism Central 10.46.28.27</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-Image</command:name> <command:verb>Set</command:verb> <command:noun>Image</command:noun> <maml:description> <maml:para>Updates the image.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates the attributes of given image.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-Image</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ImageType</maml:name> <maml:description> <maml:para>Type of the image. It can be either DISK_IMAGE or ISO_IMAGE</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">DISK_IMAGE</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ISO_IMAGE</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MetaData</maml:name> <maml:description> <maml:para>Metadata for the image to be updated. Typically, if used with `Get-Image`, it will automatically pick up the metadata from the output of Get-Im age.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EntityMetadata</command:parameterValue> <dev:type> <maml:name>EntityMetadata</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Spec</maml:name> <maml:description> <maml:para>Spec of the image to be updated. Typically, if used with `Get-Image`, it will automatically pick up the spec from the output of Get-Image.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Spec</command:parameterValue> <dev:type> <maml:name>Spec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ImageType</maml:name> <maml:description> <maml:para>Type of the image. It can be either DISK_IMAGE or ISO_IMAGE</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MetaData</maml:name> <maml:description> <maml:para>Metadata for the image to be updated. Typically, if used with `Get-Image`, it will automatically pick up the metadata from the output of Get-Im age.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EntityMetadata</command:parameterValue> <dev:type> <maml:name>EntityMetadata</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Spec</maml:name> <maml:description> <maml:para>Spec of the image to be updated. Typically, if used with `Get-Image`, it will automatically pick up the spec from the output of Get-Image.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Spec</command:parameterValue> <dev:type> <maml:name>Spec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Nutanix.Prism.DTO.V3.Spec</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Nutanix.Prism.DTO.V3.EntityMetadata</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-Image -ImageId $imageUUID | Set-Image -Name NewName | Wait-Task</dev:code> <dev:remarks> <maml:para>Changes the name of $imageUUID to NewName then wait for the task is completed. The output of Get-Image will contain the metadata and spec for the image, so the Set-Image will use them for updating the image.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VM</command:name> <command:verb>Set</command:verb> <command:noun>VM</command:noun> <maml:description> <maml:para>Updates VM.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates the VM attributes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VM</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Boot</maml:name> <maml:description> <maml:para>BootConfig object to attach. Create using New-NutanixObject then assign values to each property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BootConfigDTO</command:parameterValue> <dev:type> <maml:name>BootConfigDTO</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MemoryMb</maml:name> <maml:description> <maml:para>Memory size in Mb.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>NumCoresPerVcpu</maml:name> <maml:description> <maml:para>Number of cores per Vcpu.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>NumVcpus</maml:name> <maml:description> <maml:para>Number of Vcpu.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>UUID of the VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-VM</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Boot</maml:name> <maml:description> <maml:para>BootConfig object to attach. Create using New-NutanixObject then assign values to each property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BootConfigDTO</command:parameterValue> <dev:type> <maml:name>BootConfigDTO</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MemoryMb</maml:name> <maml:description> <maml:para>Memory size in Mb.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>NumCoresPerVcpu</maml:name> <maml:description> <maml:para>Number of cores per Vcpu.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>NumVcpus</maml:name> <maml:description> <maml:para>Number of Vcpu.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>VmInfo</maml:name> <maml:description> <maml:para>VM info object. Typically this is to be used for pipeline input from `Get-VM`, such as, Get-VM -Uuid $vmUuid | Set-VM -Name NewName.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Info</command:parameterValue> <dev:type> <maml:name>Info</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Boot</maml:name> <maml:description> <maml:para>BootConfig object to attach. Create using New-NutanixObject then assign values to each property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BootConfigDTO</command:parameterValue> <dev:type> <maml:name>BootConfigDTO</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MemoryMb</maml:name> <maml:description> <maml:para>Memory size in Mb.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>NumCoresPerVcpu</maml:name> <maml:description> <maml:para>Number of cores per Vcpu.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>NumVcpus</maml:name> <maml:description> <maml:para>Number of Vcpu.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>UUID of the VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>VmInfo</maml:name> <maml:description> <maml:para>VM info object. Typically this is to be used for pipeline input from `Get-VM`, such as, Get-VM -Uuid $vmUuid | Set-VM -Name NewName.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Info</command:parameterValue> <dev:type> <maml:name>Info</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Nutanix.Prism.Data.Vm.Info</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Nutanix.Prism.DTO.Acropolis.BootConfigDTO</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-VM -Uuid $vmUuid | Set-VM -Name NewName | Wait-Task</dev:code> <dev:remarks> <maml:para>Updates the VM name to NewName with UUID as $vmUuid and waits for the task to be completed.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-VM</command:name> <command:verb>Start</command:verb> <command:noun>VM</command:noun> <maml:description> <maml:para>Power on the VM</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets power state ON for a given VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-VM</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>UUID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-VM</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>VmInfo</maml:name> <maml:description> <maml:para>VM info object. Typically this is to be used for pipeline input from `Get-VM`, such as, Get-VM -Uuid $vmUuid | Start-VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Info</command:parameterValue> <dev:type> <maml:name>Info</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>UUID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>VmInfo</maml:name> <maml:description> <maml:para>VM info object. Typically this is to be used for pipeline input from `Get-VM`, such as, Get-VM -Uuid $vmUuid | Start-VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Info</command:parameterValue> <dev:type> <maml:name>Info</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Nutanix.Prism.Data.Vm.Info</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Start-VM $vmUuid | Wait-Task</dev:code> <dev:remarks> <maml:para>Starts the VM then wait for the task completed.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-VM -Uuid $vmUuid | Start-VM | Wait-Task</dev:code> <dev:remarks> <maml:para>Starts the VM returned from Get-VM command then wait for the task completed.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-VM</command:name> <command:verb>Stop</command:verb> <command:noun>VM</command:noun> <maml:description> <maml:para>Power off the VM</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set the power state off</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-VM</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>UUID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Stop-VM</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>VmInfo</maml:name> <maml:description> <maml:para>VM info object. Typically this is to be used for pipeline input from `Get-VM`, such as, Get-VM -Uuid $vmUuid | Stop-VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Info</command:parameterValue> <dev:type> <maml:name>Info</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>UUID of the VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>VmInfo</maml:name> <maml:description> <maml:para>VM info object. Typically this is to be used for pipeline input from `Get-VM`, such as, Get-VM -Uuid $vmUuid | Stop-VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Info</command:parameterValue> <dev:type> <maml:name>Info</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Nutanix.Prism.Data.Vm.Info</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-VM -PowerState ON | Stop-VM | Wait-Task</dev:code> <dev:remarks> <maml:para>Searches for the VM that are powered on then stop those VMs then waits for the task completed.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Wait-Task</command:name> <command:verb>Wait</command:verb> <command:noun>Task</command:noun> <maml:description> <maml:para>Waits until all tasks are finished or timeout</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Waits for one or more of tasks to finish. If Timeoutseconds is not given, waits until 30 seconds. Maximum wait time is 30 seconds. If a task does not finish till timeout, it will exit with the command to continue to wait for another 30 seconds. Run the same command to continue waiting for the task.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Wait-Task</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>TaskIds</maml:name> <maml:description> <maml:para>Task UUID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Timeoutseconds</maml:name> <maml:description> <maml:para>Waits for the given timeout then exits with error if the task is not completed within the timeout.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Wait-Task</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TaskInfos</maml:name> <maml:description> <maml:para>TaskInfo object. Typically this is for pipeline input, such as from Start-VM, Stop-VM, Set-VM, Set-Image, etc.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Nutanix.Prism.Data.Task.Info]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Nutanix.Prism.Data.Task.Info]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Timeoutseconds</maml:name> <maml:description> <maml:para>Waits for the given timeout then exits with error if the task is not completed within the timeout.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="S"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Name or IP address of Prism Central</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>TaskIds</maml:name> <maml:description> <maml:para>Task UUID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.HashSet`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TaskInfos</maml:name> <maml:description> <maml:para>TaskInfo object. Typically this is for pipeline input, such as from Start-VM, Stop-VM, Set-VM, Set-Image, etc.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Nutanix.Prism.Data.Task.Info]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Nutanix.Prism.Data.Task.Info]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Timeoutseconds</maml:name> <maml:description> <maml:para>Waits for the given timeout then exits with error if the task is not completed within the timeout.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.</maml:para> <maml:para>The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.List`1[[Nutanix.Prism.Data.Task.Info, Nutanix.Prism.Data, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.HashSet`1[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-VM -Uuid $vmUuid | Stop-VM | Wait-Task</dev:code> <dev:remarks> <maml:para>Stops the VM and waits for the task to be completed. If the -Timeoutseconds is not given, it waits for 30 seconds. If the task is still not completed, it displays an error with the TaskID and the Wait-Task command. Run the same command to continue for another 30 seconds or for the timeout given by -Timeoutsecon ds.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |