SysKit.SPDocKit.PS

1.0.6

SysKit.SPDocKit.PS.dll-help.xml

                                <?xml version="1.0" encoding="utf-8" ?>

<helpItems xmlns="http://msh" schema="maml">

  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10"

                   xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"

                   xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

    <command:details>

      <command:name>New-SPDocKitSnapshot</command:name>

      <maml:description>

        <maml:para> Creates a snapshot file of the SharePoint farm and saves it to the disk.</maml:para>

      </maml:description>

      <maml:copyright>

        <maml:para></maml:para>

      </maml:copyright>

      <command:verb>New</command:verb>

      <command:noun>SPDocKitSnapshot</command:noun>

      <dev:version></dev:version>

    </command:details>

    <maml:description>

      <maml:para>

        Crawls the SharePoint farm, creating a snapshot file containing the current state of the farm's configuration at the specified location. The created file can then be used by SPDocKit Consultant to browse the configuration and document it. Note that this process might take a while, depending on the farm size and the settings selected.

      </maml:para>

      <maml:para>

        By default, the New-SPDocKitSnapshot cmdlet does a full load of a SharePoint farm and creates the snapshot file in the current working directory. You can exclude the load of some settings by specifying the corresponding parameter.

      </maml:para>

      <maml:para>

        Errors that occur will be logged in the Windows Event Log with the source SPDocKit PS.

      </maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>New-SPDocKitSnapshot</maml:name>

        <command:parameter required="false" position="named">

          <maml:name>SiteCollectionsOff</maml:name>

        </command:parameter>

        <command:parameter required="false" position="named">

          <maml:name>PersonalSitesOff</maml:name>

        </command:parameter>

        <command:parameter required="false" position="named">

          <maml:name>FeaturesAndSolutionsOff</maml:name>

        </command:parameter>

        <command:parameter required="false" position="named">

          <maml:name>DatabasePermissionsOff</maml:name>

        </command:parameter>

        <command:parameter required="false" position="named">

          <maml:name>ProgramsAndUpdatesOff</maml:name>

        </command:parameter>

        <command:parameter required="false" position="named">

          <maml:name>SQLServerConfigurationOff</maml:name>

        </command:parameter>

        <command:parameter required="false" position="named">

          <maml:name>IISSettingsOff</maml:name>

        </command:parameter>

        <command:parameter required="false" position="named">

          <maml:name>ProjectServerSettingsOff</maml:name>

        </command:parameter>

        <command:parameter required="false" position="named">

          <maml:name>ProjectServerProjectsOff</maml:name>

        </command:parameter>

        <command:parameter required="false" position="named">

          <maml:name>Location</maml:name>

          <command:parameterValue>String</command:parameterValue>

        </command:parameter>

        <command:parameter required="false" position="named">

          <maml:name>NumberOfThreads</maml:name>

          <command:parameterValue>UInt16</command:parameterValue>

        </command:parameter>

        <command:parameter required="false" position="named">

          <maml:name>ServerLoadGlobalTimeout</maml:name>

          <command:parameterValue>UInt16</command:parameterValue>

        </command:parameter>

        <command:parameter required="false" position="named">

          <maml:name>ServerLoadOperationTimeout</maml:name>

          <command:parameterValue>UInt16</command:parameterValue>

        </command:parameter>

        <command:parameter required="false" position="named">

          <maml:name>FarmAccessTimeout</maml:name>

          <command:parameterValue>UInt16</command:parameterValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" position="named">

        <maml:name>SiteCollectionsOff  or  -noSites</maml:name>

        <maml:description>

          <maml:para>If set, site collections will not be loaded. Load depth will be set to web applications.</maml:para>

        </maml:description>

      </command:parameter>

      <command:parameter required="false" position="named">

        <maml:name>PersonalSitesOff  or  -noPers</maml:name>

        <maml:description>

          <maml:para>If set, personal sites will be skipped.</maml:para>

        </maml:description>

      </command:parameter>

      <command:parameter required="false" position="named">

        <maml:name>FeaturesAndSolutionsOff  or  -noFeats</maml:name>

        <maml:description>

          <maml:para>If set, features and solutions will not be loaded.</maml:para>

        </maml:description>

      </command:parameter>

      <command:parameter required="false" position="named">

        <maml:name>DatabasePermissionsOff  or  -noDbPerm</maml:name>

        <maml:description>

          <maml:para>If set, database permissions will not be loaded.</maml:para>

        </maml:description>

      </command:parameter>

      <command:parameter required="false" position="named">

        <maml:name>ProgramsAndUpdatesOff  or  -noUpdates</maml:name>

        <maml:description>

          <maml:para>If set, programs and updates will not be loaded.</maml:para>

        </maml:description>

      </command:parameter>

      <command:parameter required="false" position="named">

        <maml:name>SQLServerConfigurationOff  or  -noSQL</maml:name>

        <maml:description>

          <maml:para>If set, SQL Server configuration will not be loaded.</maml:para>

        </maml:description>

      </command:parameter>

      <command:parameter required="false" position="named">

        <maml:name>IISSettingsOff  or  -noIIS</maml:name>

        <maml:description>

          <maml:para>If set, IIS settings will not be loaded.</maml:para>

        </maml:description>

      </command:parameter>

      <command:parameter required="false" position="named">

        <maml:name>ProjectServerSettingsOff  or  -noPSSettings</maml:name>

        <maml:description>

          <maml:para>If set, Project Server settings and Project Server projects will not be loaded.</maml:para>

        </maml:description>

      </command:parameter>

      <command:parameter required="false" position="named">

        <maml:name>ProjectServerProjectsOff  or  -noPSProj</maml:name>

        <maml:description>

          <maml:para>If set, Project Server projects will not be loaded.</maml:para>

        </maml:description>

      </command:parameter>

      <command:parameter required="false" position="named">

        <maml:name>Location  or  -l</maml:name>

        <maml:description>

          <maml:para>Defines the location on the disk where the SPDocKit snapshot file will be saved.</maml:para>

        </maml:description>

        <command:parameterValue required="true">

          String

        </command:parameterValue>

        <dev:defaultValue>Current working directory</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" position="named">

        <maml:name>NumberOfThreads  or  -threads</maml:name>

        <maml:description>

          <maml:para>Defines the number of threads that will be used for parallel load. Maximum number is 32.</maml:para>

        </maml:description>

        <command:parameterValue required="true">

          UInt16

        </command:parameterValue>

        <dev:defaultValue>4</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" position="named">

        <maml:name>ServerLoadGlobalTimeout  or  -globalTimeout</maml:name>

        <maml:description>

          <maml:para>Defines the timeout for the entire server load process in seconds.</maml:para>

        </maml:description>

        <command:parameterValue required="true">

          UInt16

        </command:parameterValue>

        <dev:defaultValue>1800</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" position="named">

        <maml:name>ServerLoadOperationTimeout  or  -operationTimeout</maml:name>

        <maml:description>

          <maml:para>Defines the timeout for a single server load in seconds.</maml:para>

        </maml:description>

        <command:parameterValue required="true">

          UInt16

        </command:parameterValue>

        <dev:defaultValue>900</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" position="named">

        <maml:name>FarmAccessTimeout  or  -accessTimeout</maml:name>

        <maml:description>

          <maml:para>Defines the timeout for accessing the SharePoint farm in seconds.</maml:para>

        </maml:description>

        <command:parameterValue required="true">

          UInt16

        </command:parameterValue>

        <dev:defaultValue>120</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" position="named">

        <maml:name>Verbose</maml:name>

        <maml:description>

          <maml:para>If set, a log file will be created and saved to the same directory as the snapshot file.</maml:para>

        </maml:description>

      </command:parameter>

    </command:parameters>

    <command:examples>

      <command:example>

        <maml:title>

          ———————— EXAMPLE 1 ————————

        </maml:title>

        <dev:code>New-SPDocKitSnapshot</dev:code>

        <dev:remarks>

          <maml:para>Does a full load of the SharePoint farm and creates a snapshot file in the default location (current working directory).</maml:para>

          <maml:para></maml:para>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>

          ———————— EXAMPLE 2 ————————

        </maml:title>

        <dev:code>New-SPDocKitSnapshot -PersonalSitesOff -DatabasePermissionsOff -threads 8 -location "C:\spdockit\"</dev:code>

        <dev:remarks>

          <maml:para>Skips personal sites and does not load database permissions, using 8 threads for parallel load. Saves the snapshot file to "C:\spdockit\" folder. </maml:para>

          <maml:para></maml:para>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>

          ———————— EXAMPLE 3 ————————

        </maml:title>

        <dev:code> New-SPDocKitSnapshot -noFeats -noUpdates -noIIS -noSQL</dev:code>

        <dev:remarks>

          <maml:para>Excludes features and solutions, programs and updates, IIS settings and SQL Server configuration from a load, using aliases instead of full named parameters.</maml:para>

          <maml:para></maml:para>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>

          ———————— EXAMPLE 4 ————————

        </maml:title>

        <dev:code> New-SPDocKitSnapshot -globalTimeout 3000 -FarmAccessTimeout 500</dev:code>

        <dev:remarks>

          <maml:para>Sets the server global timeout to 3000 seconds, farm access timeout to 500 seconds and does a full load of the SharePoint farm, saving the snapshot file to the default location (current working directory).</maml:para>

          <maml:para></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:details>

      <command:name>Get-SPDocKitVersion</command:name>

      <maml:description>

        <maml:para>Returns the SPDocKit version.</maml:para>

      </maml:description>

      <maml:copyright>

        <maml:para></maml:para>

      </maml:copyright>

      <command:verb>Get</command:verb>

      <command:noun>SPDocKitVersion</command:noun>

      <dev:version></dev:version>

    </command:details>

  </command:command>

</helpItems>