posh-kentico

0.0.61

posh-kentico.dll-Help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh">
  <!-- Cmdlet: Initialize-CMSApplication -->
  <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>Initialize-CMSApplication</command:name>
      <command:verb>Initialize</command:verb>
      <command:noun>CMSApplication</command:noun>
      <maml:description>
        <maml:para>Initializes a connection to the Kentico CMS Server.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>The Initialize-CMSApplication cmdlet initializes a connection to the Kentico CMS server.</maml:para>
      <maml:para></maml:para>
      <maml:para>If this cmdlet is run without parameters, then it requires administrator permissions to find the Kentico site.</maml:para>
      <maml:para>It does so by performing the following steps:</maml:para>
      <maml:para>1. Get a list of all the sites from IIS</maml:para>
      <maml:para>2. Get a list of all applications from the sites</maml:para>
      <maml:para>3. Get a list of all the virtual directories from the applications</maml:para>
      <maml:para>4. Continue processing virtual directory if a web.config file exits</maml:para>
      <maml:para>5. Parse the document and find an "add" node with name="CMSConnectionString"</maml:para>
      <maml:para>6. If the connection string is valid, then stop processing</maml:para>
    </maml:description>
    <command:syntax>
      <!-- Parameter set: ConnectionString -->
      <command:syntaxItem>
        <maml:name>Initialize-CMSApplication</maml:name>
        <!-- Parameter: ConnectionString -->
        <command:parameter required="true" globbing="false" pipelineInput="false" position="0">
          <maml:name>ConnectionString</maml:name>
          <maml:description>
            <maml:para>The connection string for the database connection.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: WebRoot -->
        <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="KenticoRoot">
          <maml:name>WebRoot</maml:name>
          <maml:description>
            <maml:para>The root directory for the Kentico site.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
      </command:syntaxItem>
      <!-- Parameter set: ServerAndDatabase -->
      <command:syntaxItem>
        <maml:name>Initialize-CMSApplication</maml:name>
        <!-- Parameter: DatabaseServer -->
        <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="SQLServer">
          <maml:name>DatabaseServer</maml:name>
          <maml:description>
            <maml:para>The database server to use for generating the connection string.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: Database -->
        <command:parameter required="true" globbing="false" pipelineInput="false" position="1">
          <maml:name>Database</maml:name>
          <maml:description>
            <maml:para>The database to use for generating the connection string.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: WebRoot -->
        <command:parameter required="true" globbing="false" pipelineInput="false" position="2" aliases="KenticoRoot">
          <maml:name>WebRoot</maml:name>
          <maml:description>
            <maml:para>The root directory for the Kentico site.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: Timeout -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>Timeout</maml:name>
          <maml:description>
            <maml:para>The timeout to use for generating the connection string.</maml:para>
          </maml:description>
          <command:parameterValue required="true">int</command:parameterValue>
          <dev:type>
            <maml:name>System.Int32</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>60</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <!-- Parameter: ConnectionString -->
      <command:parameter required="true" globbing="false" pipelineInput="false" position="0">
        <maml:name>ConnectionString</maml:name>
        <maml:description>
          <maml:para>The connection string for the database connection.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: DatabaseServer -->
      <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="SQLServer">
        <maml:name>DatabaseServer</maml:name>
        <maml:description>
          <maml:para>The database server to use for generating the connection string.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="SQLServer">
        <maml:name>SQLServer</maml:name>
        <maml:description>
          <maml:para>The database server to use for generating the connection string.</maml:para>
          <maml:para>This is an alias of the DatabaseServer parameter.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: Database -->
      <command:parameter required="true" globbing="false" pipelineInput="false" position="1">
        <maml:name>Database</maml:name>
        <maml:description>
          <maml:para>The database to use for generating the connection string.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: Timeout -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>Timeout</maml:name>
        <maml:description>
          <maml:para>The timeout to use for generating the connection string.</maml:para>
        </maml:description>
        <command:parameterValue required="true">int</command:parameterValue>
        <dev:type>
          <maml:name>System.Int32</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>60</dev:defaultValue>
      </command:parameter>
      <!-- Parameter: WebRoot -->
      <command:parameter required="true" globbing="false" pipelineInput="false" position="2" aliases="KenticoRoot">
        <maml:name>WebRoot</maml:name>
        <maml:description>
          <maml:para>The root directory for the Kentico site.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <command:parameter required="true" globbing="false" pipelineInput="false" position="2" aliases="KenticoRoot">
        <maml:name>KenticoRoot</maml:name>
        <maml:description>
          <maml:para>The root directory for the Kentico site.</maml:para>
          <maml:para>This is an alias of the WebRoot parameter.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
    </command:parameters>
    <command:inputTypes />
    <command:returnValues />
    <command:examples>
      <command:example>
        <maml:title>---------- EXAMPLE 1 ----------</maml:title>
        <maml:introduction>
          <maml:para>Initialize the Kentico CMS Application by searching for the Kentico site.</maml:para>
          <maml:para>This option requires administrator rights.</maml:para>
        </maml:introduction>
        <dev:code>Initialize-CMSApplication</dev:code>
      </command:example>
      <command:example>
        <maml:title>---------- EXAMPLE 2 ----------</maml:title>
        <maml:introduction>
          <maml:para>Initialize the Kentico CMS Application by using the specified connection string.</maml:para>
          <maml:para>This option does not require administrator rights.</maml:para>
        </maml:introduction>
        <dev:code>Initialize-CMSApplication -DatabaseServer KenticoServer -Database Kentico -WebRoot C:\kentico</dev:code>
      </command:example>
    </command:examples>
  </command:command>
  <!-- Cmdlet: Get-CMSWebPartCategory -->
  <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-CMSWebPartCategory</command:name>
      <command:verb>Get</command:verb>
      <command:noun>CMSWebPartCategory</command:noun>
      <maml:description>
        <maml:para>Gets the web part categories selected by the provided input.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Gets the web part categories selected by the provided input. This command automatically initializes the connection to Kentico if not already initialized.</maml:para>
      <maml:para></maml:para>
      <maml:para>Without parameters, this command returns all webpart categories.</maml:para>
      <maml:para>With parameters, this command returns the webpart categories that match the criteria.</maml:para>
    </maml:description>
    <command:syntax>
      <!-- Parameter set: Category Name -->
      <command:syntaxItem>
        <maml:name>Get-CMSWebPartCategory</maml:name>
        <!-- Parameter: CategoryName -->
        <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="DisplayName,Name,Path">
          <maml:name>CategoryName</maml:name>
          <maml:description>
            <maml:para>The category name, display name, or path of the webpart category.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: Exact -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>Exact</maml:name>
          <maml:description>
            <maml:para>If set, the match is exact, else the match performs a contains for display name and category name and starts with for path.</maml:para>
          </maml:description>
          <command:parameterValue required="true">SwitchParameter</command:parameterValue>
          <dev:type>
            <maml:name>System.Management.Automation.SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <!-- Parameter: CategoryName -->
      <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="DisplayName,Name,Path">
        <maml:name>CategoryName</maml:name>
        <maml:description>
          <maml:para>The category name, display name, or path of the webpart category.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="DisplayName,Name,Path">
        <maml:name>DisplayName</maml:name>
        <maml:description>
          <maml:para>The category name, display name, or path of the webpart category.</maml:para>
          <maml:para>This is an alias of the CategoryName parameter.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="DisplayName,Name,Path">
        <maml:name>Name</maml:name>
        <maml:description>
          <maml:para>The category name, display name, or path of the webpart category.</maml:para>
          <maml:para>This is an alias of the CategoryName parameter.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="DisplayName,Name,Path">
        <maml:name>Path</maml:name>
        <maml:description>
          <maml:para>The category name, display name, or path of the webpart category.</maml:para>
          <maml:para>This is an alias of the CategoryName parameter.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: Exact -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>Exact</maml:name>
        <maml:description>
          <maml:para>If set, the match is exact, else the match performs a contains for display name and category name and starts with for path.</maml:para>
        </maml:description>
        <command:parameterValue required="true">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>System.Management.Automation.SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>False</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
        <maml:description>
          <maml:para>The category name, display name, or path of the webpart category.</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues />
    <command:examples>
      <command:example>
        <maml:title>---------- EXAMPLE 1 ----------</maml:title>
        <maml:introduction>
          <maml:para>Get all the webpart categories.</maml:para>
        </maml:introduction>
        <dev:code>Get-CMSWebPartCategory</dev:code>
      </command:example>
      <command:example>
        <maml:title>---------- EXAMPLE 2 ----------</maml:title>
        <maml:introduction>
          <maml:para>Get all webparts with a category name "*bas*", display name "*bas*", or a path "bas*".</maml:para>
        </maml:introduction>
        <dev:code>Get-CMSWebPartCategory bas</dev:code>
      </command:example>
      <command:example>
        <maml:title>---------- EXAMPLE 3 ----------</maml:title>
        <maml:introduction>
          <maml:para>Get all webparts with a category name "basic", display name "basic", or path "basic"</maml:para>
        </maml:introduction>
        <dev:code>Get-CMSWebPartCategory basic -Exact</dev:code>
      </command:example>
    </command:examples>
  </command:command>
</helpItems>