UofIDMI

1.0.1

en-US/UofIDMI-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-DMIDepartment</command:name>
      <command:verb>Get</command:verb>
      <command:noun>DMIDepartment</command:noun>
      <maml:description>
        <maml:para>Returns the information for all departments or a specified department.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Returns the information for all departments or a specified department.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-DMIDepartment</maml:name>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
          <maml:name>BannerOrg</maml:name>
          <maml:Description>
            <maml:para>Banner organization code. This is an alphanumeric code in 4 sections. Ex: '1A1-NA-NA0-283'</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>%</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">
          <maml:name>Deptname</maml:name>
          <maml:Description>
            <maml:para>Plaint text department name. Ex: 'Academic Outreach'</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>%</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
        <maml:name>BannerOrg</maml:name>
        <maml:Description>
          <maml:para>Banner organization code. This is an alphanumeric code in 4 sections. Ex: '1A1-NA-NA0-283'</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>%</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">
        <maml:name>Deptname</maml:name>
        <maml:Description>
          <maml:para>Plaint text department name. Ex: 'Academic Outreach'</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>%</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes />
    <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>Get-DMIDepartment</dev:code>
        <dev:remarks>
          <maml:para>This will return all departments.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>
        <dev:code>Get-DMIDepartment -BannerOrg '1A1-NA-NA0-283'</dev:code>
        <dev:remarks>
          <maml:para>This will return a specific department based on banner organization code.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title>
        <dev:code>Get-DMIDepartment -Deptname 'Academic Outreach'</dev:code>
        <dev:remarks>
          <maml:para>This will return a specific department based on department name.</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-DMISQLiteDB</command:name>
      <command:verb>New</command:verb>
      <command:noun>DMISQLiteDB</command:noun>
      <maml:description>
        <maml:para>Creates a new instance of a SQLite database locally to store the DMI information in. This should be created automatically by the module.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Creates a new instance of a SQLite database locally to store the DMI information in. This should be created automatically by the module.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>New-DMISQLiteDB</maml:name>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters />
    <command:inputTypes />
    <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>New-DMISQLiteDB</dev:code>
        <dev:remarks>
          <maml:para></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>Update-DMICache</command:name>
      <command:verb>Update</command:verb>
      <command:noun>DMICache</command:noun>
      <maml:description>
        <maml:para>This command will update the contents of the SQLite database created by New-DMISQLiteDB.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>This command will update the contents of the SQLite database created by New-DMISQLiteDB.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Update-DMICache</maml:name>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>ParamCacheOnly</maml:name>
          <maml:Description>
            <maml:para>This will update the tab completion cache for Get-DMIDepartment only and not update the SQLite database.</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:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>ParamCacheOnly</maml:name>
        <maml:Description>
          <maml:para>This will update the tab completion cache for Get-DMIDepartment only and not update the SQLite database.</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:parameters>
    <command:inputTypes />
    <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>Update-DMICache</dev:code>
        <dev:remarks>
          <maml:para>This will clear out and populate the SQLite database. It will also update the tab completion cache for Get-DMIDepartment.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks />
  </command:command>
</helpItems>