VMFSIncrease

1.0.0.0

en-US/VMFSIncrease.psm1-Help.xml

<?xml version="1.0" encoding="utf-8" ?>
<helpItems xmlns="http://msh" schema="maml">
    <!--Edited with: SAPIEN PowerShell HelpWriter 2015 v1.0.16-->
    <!--Generated by: SAPIEN PowerShell HelpWriter 2015 v1.0.16-->
    <!--
        Module: VMFSIncrease
        Version: 1.0.0.0
    -->
    <!--All Commands-->
    <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
        <!--Command-->
        <command:details>
            <command:name>Get-VmfsDatastoreInfo</command:name>
            <maml:description>
                <maml:para>Provides partition information for all the extents in the datastore.</maml:para>
            </maml:description>
            <maml:copyright>
                <maml:para/>
            </maml:copyright>
            <command:verb>Get</command:verb>
            <command:noun>VmfsDatastoreInfo</command:noun>
            <dev:version/>
        </command:details>
        <maml:description>
            <maml:para>The function will display partition information for all the extents used by the datastore.</maml:para>
        </maml:description>
        <command:syntax>
            <!--Parameter Sets-->
            <command:syntaxItem>
                <maml:name>Get-VmfsDatastoreInfo</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="">
                    <maml:name>Datastore</maml:name>
                    <maml:description>
                        <maml:para>The name of the Datastore or a PowerCLI Datastore object</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>
                    <dev:defaultValue>
                    </dev:defaultValue>
                </command:parameter>
            </command:syntaxItem>
        </command:syntax>
        <command:parameters>
            <!--All Parameters-->
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="">
                <maml:name>Datastore</maml:name>
                <maml:description>
                    <maml:para>The name of the Datastore or a PowerCLI Datastore object</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>
                <dev:type>
                    <maml:name>PSObject</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue>
                </dev:defaultValue>
            </command:parameter>
        </command:parameters>
        <command:inputTypes>
            <!--Inputs-->
            <command:inputType>
                <dev:type>
                    <maml:name>System.Management.Automation.PSObject
                    </maml:name>
                    <maml:uri/>
                </dev:type>
                <maml:description>
                    <maml:para/>
                </maml:description>
            </command:inputType>
        </command:inputTypes>
        <command:returnValues>
            <!--Outputs-->
            <command:returnValue>
                <dev:type>
                    <maml:name>System.Object</maml:name>
                    <maml:uri/>
                </dev:type>
                <maml:description>
                    <maml:para/>
                </maml:description>
            </command:returnValue>
        </command:returnValues>
        <command:examples>
            <!--Examples-->
            <command:example>
                <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para>PS C:\&gt;</maml:para>
                </maml:introduction>
                <dev:code>Get-VmfsDatastoreInfo -Datastore MyDS</dev:code>
                <dev:remarks>
                    <maml:para>Will return partition information for the Datastore named MyDS</maml:para>
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para>PS C:\&gt;</maml:para>
                </maml:introduction>
                <dev:code>Get-Datastore -Name My* | Get-VmfsDatastoreInfo</dev:code>
                <dev:remarks>
                    <maml:para>This example will return partition information for all the Datastore objects that are returned by the Get-Datastore PowerCLI cmdlet</maml:para>
                </dev:remarks>
            </command:example>
        </command:examples>
    </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">
        <!--Command-->
        <command:details>
            <command:name>Get-VmfsDatastoreIncrease</command:name>
            <maml:description>
                <maml:para>Displays the increase options for a datastore</maml:para>
            </maml:description>
            <maml:copyright>
                <maml:para/>
            </maml:copyright>
            <command:verb>Get</command:verb>
            <command:noun>VmfsDatastoreIncrease</command:noun>
            <dev:version/>
        </command:details>
        <maml:description>
            <maml:para>The function will provide all the Expand and Extend options for a specific datastore</maml:para>
        </maml:description>
        <command:syntax>
            <!--Parameter Sets-->
            <command:syntaxItem>
                <maml:name>Get-VmfsDatastoreIncrease</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="">
                    <maml:name>Datastore</maml:name>
                    <maml:description>
                        <maml:para>The name of the Datastore or a PowerCLI Datastore object</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>
                    <dev:defaultValue>
                    </dev:defaultValue>
                </command:parameter>
            </command:syntaxItem>
        </command:syntax>
        <command:parameters>
            <!--All Parameters-->
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="">
                <maml:name>Datastore</maml:name>
                <maml:description>
                    <maml:para>The name of the Datastore or a PowerCLI Datastore object</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>
                <dev:type>
                    <maml:name>PSObject</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue>
                </dev:defaultValue>
            </command:parameter>
        </command:parameters>
        <command:inputTypes>
            <!--Inputs-->
            <command:inputType>
                <dev:type>
                    <maml:name>System.Management.Automation.PSObject
                    </maml:name>
                    <maml:uri/>
                </dev:type>
                <maml:description>
                    <maml:para/>
                </maml:description>
            </command:inputType>
        </command:inputTypes>
        <command:returnValues>
            <!--Outputs-->
            <command:returnValue>
                <dev:type>
                    <maml:name>System.Object</maml:name>
                    <maml:uri/>
                </dev:type>
                <maml:description>
                    <maml:para/>
                </maml:description>
            </command:returnValue>
        </command:returnValues>
        <command:examples>
            <!--Examples-->
            <command:example>
                <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para>PS C:\&gt;</maml:para>
                </maml:introduction>
                <dev:code>Get-VmfsDatastoreIncrease -Datastore MyDS</dev:code>
                <dev:remarks>
                    <maml:para>The exmaple will list all Expand and Extend options available for the Datastore, named MyDS</maml:para>
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para>PS C:\&gt;</maml:para>
                </maml:introduction>
                <dev:code>Get-Datastore -Name MyDS* | Get-VmfsDatastoreIncrease</dev:code>
                <dev:remarks>
                    <maml:para>The Expand and Extend options for all Datastore retruned by the PowerCLI Get-Datastore will be returned.</maml:para>
                </dev:remarks>
            </command:example>
        </command:examples>
    </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">
        <!--Command-->
        <command:details>
            <command:name>New-VmfsDatastoreIncrease</command:name>
            <maml:description>
                <maml:para>Increase the capacity of a Datastore</maml:para>
            </maml:description>
            <maml:copyright>
                <maml:para/>
            </maml:copyright>
            <command:verb>New</command:verb>
            <command:noun>VmfsDatastoreIncrease</command:noun>
            <dev:version/>
        </command:details>
        <maml:description>
            <maml:para>The capacity of the Datastore in increased through an Expand or an Extend.
To allow successful completion there shall be free capacity on one of the Extents, or there shall be free LUNs available.
With the Expand or Extend switches the caller selects which type of capacity increase is used.</maml:para>
        </maml:description>
        <command:syntax>
            <!--Parameter Sets-->
            <command:syntaxItem>
                <maml:name>New-VmfsDatastoreIncrease</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="">
                    <maml:name>Datastore</maml:name>
                    <maml:description>
                        <maml:para>The name of the Datastore or a PowerCLI Datastore object</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>
                    <dev:defaultValue>
                    </dev:defaultValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="">
                    <maml:name>CanonicalName</maml:name>
                    <maml:description>
                        <maml:para>The Canonical name of the LUN on which to create a new Extent, or the name of the LUN on which to apply the Expansion.
If this parameter is not provided, the function will sort the available LUN alphanumerically on the Canonical names and slect the first one.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
                    <dev:defaultValue>
                    </dev:defaultValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
                    <maml:name>IncreaseSizeGB</maml:name>
                    <maml:description>
                        <maml:para>The amount of GB by which to increase the size of the Datastore.
If this parameter is not used, all of the available Expand or Extend diskspace will be used.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
                    <dev:defaultValue>
                    </dev:defaultValue>
                </command:parameter>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
                    <maml:name>Expand</maml:name>
                    <maml:description>
                        <maml:para>A switch to indicate if the Datastore shall be Expanded</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
                    <dev:defaultValue>
                    </dev:defaultValue>
                </command:parameter>
            </command:syntaxItem>
            <command:syntaxItem>
                <maml:name>New-VmfsDatastoreIncrease</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="">
                    <maml:name>Datastore</maml:name>
                    <maml:description>
                        <maml:para>The name of the Datastore or a PowerCLI Datastore object</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>
                    <dev:defaultValue>
                    </dev:defaultValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="">
                    <maml:name>CanonicalName</maml:name>
                    <maml:description>
                        <maml:para>The Canonical name of the LUN on which to create a new Extent, or the name of the LUN on which to apply the Expansion.
If this parameter is not provided, the function will sort the available LUN alphanumerically on the Canonical names and slect the first one.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
                    <dev:defaultValue>
                    </dev:defaultValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
                    <maml:name>IncreaseSizeGB</maml:name>
                    <maml:description>
                        <maml:para>The amount of GB by which to increase the size of the Datastore.
If this parameter is not used, all of the available Expand or Extend diskspace will be used.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
                    <dev:defaultValue>
                    </dev:defaultValue>
                </command:parameter>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
                    <maml:name>Extend</maml:name>
                    <maml:description>
                        <maml:para>A switch to indicate if the Datastore shall be Extended</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
                    <dev:defaultValue>
                    </dev:defaultValue>
                </command:parameter>
            </command:syntaxItem>
        </command:syntax>
        <command:parameters>
            <!--All Parameters-->
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="">
                <maml:name>Datastore</maml:name>
                <maml:description>
                    <maml:para>The name of the Datastore or a PowerCLI Datastore object</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>
                <dev:type>
                    <maml:name>PSObject</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue>
                </dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
                <maml:name>IncreaseSizeGB</maml:name>
                <maml:description>
                    <maml:para>The amount of GB by which to increase the size of the Datastore.
If this parameter is not used, all of the available Expand or Extend diskspace will be used.</maml:para>
                </maml:description>
                <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue>
                <dev:type>
                    <maml:name>Int32</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue>
                </dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="">
                <maml:name>CanonicalName</maml:name>
                <maml:description>
                    <maml:para>The Canonical name of the LUN on which to create a new Extent, or the name of the LUN on which to apply the Expansion.
If this parameter is not provided, the function will sort the available LUN alphanumerically on the Canonical names and slect the first one.</maml:para>
                </maml:description>
                <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
                <dev:type>
                    <maml:name>String</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue>
                </dev:defaultValue>
            </command:parameter>
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
                <maml:name>Expand</maml:name>
                <maml:description>
                    <maml:para>A switch to indicate if the Datastore shall be Expanded</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue>
                <dev:type>
                    <maml:name>SwitchParameter</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue>
                </dev:defaultValue>
            </command:parameter>
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
                <maml:name>Extend</maml:name>
                <maml:description>
                    <maml:para>A switch to indicate if the Datastore shall be Extended</maml:para>
                </maml:description>
                <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue>
                <dev:type>
                    <maml:name>SwitchParameter</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue>
                </dev:defaultValue>
            </command:parameter>
        </command:parameters>
        <command:inputTypes>
            <!--Inputs-->
            <command:inputType>
                <dev:type>
                    <maml:name>System.Management.Automation.PSObject
                    </maml:name>
                    <maml:uri/>
                </dev:type>
                <maml:description>
                    <maml:para/>
                </maml:description>
            </command:inputType>
        </command:inputTypes>
        <command:returnValues>
            <!--Outputs-->
            <command:returnValue>
                <dev:type>
                    <maml:name>System.Object</maml:name>
                    <maml:uri/>
                </dev:type>
                <maml:description>
                    <maml:para/>
                </maml:description>
            </command:returnValue>
        </command:returnValues>
        <command:examples>
            <!--Examples-->
            <command:example>
                <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para>PS C:\&gt;</maml:para>
                </maml:introduction>
                <dev:code>New-VmfsDatastoreIncrease -Datastore MyDS -Expand</dev:code>
                <dev:remarks>
                    <maml:para>The capacity of the Datastore, named MyDS, will be Expanded with all available free space on the first extent of the Datastore.</maml:para>
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para>PS C:\&gt;</maml:para>
                </maml:introduction>
                <dev:code>New-VmfsDatastoreIncrease -Name MyDS -Expand -IncreaseSizeGB 25</dev:code>
                <dev:remarks>
                    <maml:para>The capacity of the Datastore, named MyDS, will be Expanded with 25GB on the first extent of the Datastore.
Provided if course, this amount of free space is available.</maml:para>
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para>PS C:\&gt;</maml:para>
                </maml:introduction>
                <dev:code>New-VmfsDatastoreIncrease -Datastore &apos;TestDS&apos; -Expand -IncreaseSizeGB 15 -CanonicalName &apos;naa.600507680180732f1800000000000011&apos;</dev:code>
                <dev:remarks>
                    <maml:para>The capacity of the Datastore MyDS will be increased with 15GB on the extent with the Canonicalname naa.600507680180732f1800000000000011</maml:para>
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para>PS C:\&gt;</maml:para>
                </maml:introduction>
                <dev:code>New-VmfsDatastoreIncrease -Datastore MyDS -Expand -CanonicalName &apos;naa.600507680180732f1800000000000012&apos;</dev:code>
                <dev:remarks>
                    <maml:para>The capacity of the Datastore MyDS will be increased with all available free space on the extent with the Canonicalname naa.600507680180732f1800000000000012</maml:para>
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para>PS C:\&gt;</maml:para>
                </maml:introduction>
                <dev:code>New-VmfsDatastoreIncrease -Datastore MyDS -Extend</dev:code>
                <dev:remarks>
                    <maml:para>A new Extent will be added to Datastore MyDS.
All available free space of the LUN will be allocated.
The available LUNs are ordered alphanumerically by their Canonicalname, and the first LUN is used.</maml:para>
                </dev:remarks>
            </command:example>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para>PS C:\&gt;</maml:para>
                </maml:introduction>
                <dev:code>Get-Datastore -Name MyDS | New-VmfsDatastoreIncrease -Extend -IncreaseSizeGB 50</dev:code>
                <dev:remarks>
                    <maml:para>The capacity of the Datastore returned by the PowerCLI Get-Datastore cmdlet will be increased by 50GB.
This is done by adding a new Extent to the Datastore.
The available LUNs are ordered alphanumerically by their Canonicalname, and the first LUN is used.</maml:para>
                </dev:remarks>
            </command:example>
        </command:examples>
    </command:command>
    <!--Generated by: SAPIEN PowerShell HelpWriter 2015 v1.0.16-->
</helpItems>