framework/ncacheps.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Install-NCacheModule --> <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>Install-NCacheModule</command:name> <maml:description> <maml:para>Installs required assemblies.</maml:para> </maml:description> <command:verb>Install</command:verb> <command:noun>NCacheModule</command:noun> </command:details> <command:description> <maml:para>Install-NCacheModule cmdlet enables the user to deploy provider assemblies to the deployment folder in NCache installed directory. </maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Install-NCacheModule</maml:name> <!-- Parameter: AssemblyPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AssemblyPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: CacheName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AssemblyPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AssemblyPath</maml:name> <maml:description> <maml:para>Specifies the path of the assembly to be imported.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: CacheName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <maml:description> <maml:para>Specifies the name of the cache for assemblyӳ deployment.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the NCache server name/ip.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on which NCache server is listening. Default port is 8250.</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>8250</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Install-NCacheModule -CacheName demoCache -AssemblyPath C:\Provider.dll</dev:code> <dev:remarks> <maml:para>This command deploys the assembly for demoCache.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Install-NCacheModule -CacheName demoCache -AssemblyPath C:\Provider.dll -Server 20.200.21.11</dev:code> <dev:remarks> <maml:para>This command deploys the assembly for demoCache on server 20.200.21.11.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Clear-Cache --> <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>Clear-Cache</command:name> <maml:description> <maml:para>Clears the registered cache.</maml:para> </maml:description> <command:verb>Clear</command:verb> <command:noun>Cache</command:noun> </command:details> <command:description> <maml:para>Clear-Cache cmdlet enables the user to clear the cache by removing all the items present in the cache. </maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Clear-Cache</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ClearJSS --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClearJSS</maml:name> <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> <!-- Parameter: ForceClear --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ForceClear</maml:name> <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> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the cache for which you want to use this tool.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ForceClear --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ForceClear</maml:name> <maml:description> <maml:para>Force the clearing of the cache. If not specified, the user is asked before clearing the cache.</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> <!-- Parameter: ClearJSS --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClearJSS</maml:name> <maml:description> <maml:para>Clear JavaScript and CSS only.</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> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Clear-Cache -Name demoCache</dev:code> <dev:remarks> <maml:para>This command clears the demoCache.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Clear-Cache -Name demoCache -ForceClear</dev:code> <dev:remarks> <maml:para>This command forcefully clears the cache and does not ask the user before clearing the cache.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Clear-Cache -Name demoCache -ClearJSS</dev:code> <dev:remarks> <maml:para>This command clears JavaScript or CSS content from the cache.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-Cache --> <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-Cache</command:name> <maml:description> <maml:para>Creates a new cache.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>Cache</command:noun> </command:details> <command:description> <maml:para>New-Cache cmdlet enables the user to create a new cache on one or more server nodes.</maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-Cache</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: CleanupInterval --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>CleanupInterval</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: ClusterPort --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>ClusterPort</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DefaultPriority --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>DefaultPriority</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: EvictionRatio --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>EvictionRatio</maml:name> <command:parameterValue required="true">Decimal</command:parameterValue> <dev:type> <maml:name>System.Decimal</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Inproc --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Inproc</maml:name> <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> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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> <!-- Parameter: Path --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Path</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Size --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Size</maml:name> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Topology --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Topology</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cache for which cache will be registered.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Inproc --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Inproc</maml:name> <maml:description> <maml:para>Specifies the isolation level for local cache.</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> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the NCache server names/IPs where Cache should be configured, separated by commas e.g. 20.200.21.11,20.200.21.12</maml:para> </maml:description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on which NCache server is listening. Default port is 8250.</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>8250</dev:defaultValue> </command:parameter> <!-- Parameter: Size --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Size</maml:name> <maml:description> <maml:para>Specifies the size (MB) of the cache to be created. Default value is 1024 MB for local cache.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1024</dev:defaultValue> </command:parameter> <!-- Parameter: EvictionRatio --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>EvictionRatio</maml:name> <maml:description> <maml:para>Specifies the eviction ratio (Percentage) for cache items. Cached items will be cleaned from the cache according to the specified ratio if the cache reaches its limit. Default value is 5 (percent)</maml:para> </maml:description> <command:parameterValue required="true">Decimal</command:parameterValue> <dev:type> <maml:name>System.Decimal</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: CleanupInterval --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>CleanupInterval</maml:name> <maml:description> <maml:para>Specifies the time interval (seconds) after which cache cleanup is called. Default clean-interval is 15 (seconds)</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>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Topology --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Topology</maml:name> <maml:description> <maml:para>For topology other than local you have to give topology and cluster port. Specifies the topology in case of clustered cache. Possible values are</maml:para> <maml:para>I. Local</maml:para> <maml:para>II. Replicated</maml:para> <maml:para>III. Partitioned </maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ClusterPort --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>ClusterPort</maml:name> <maml:description> <maml:para>Specifies the port of the server, at which server listens.</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></dev:defaultValue> </command:parameter> <!-- Parameter: DefaultPriority --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>DefaultPriority</maml:name> <maml:description> <maml:para>Specifies the default priority in case of priority based eviction policy is selected. Possible values are</maml:para> <maml:para>i. high</maml:para> <maml:para>ii. above-normal</maml:para> <maml:para>iii. normal (default)</maml:para> <maml:para>iv. below-normal</maml:para> <maml:para>v. low</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Path --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path of the cache source config which will be configured.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>New-Cache -Name demoCache -Server 20.200.21.11 -Size 1024</dev:code> <dev:remarks> <maml:para>This command creates new cache named demoCache on server 20.200.21.11 having size 1024 MB and topology local for simple case.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>New-Cache -Name demoCache -Server 20.200.21.11 -Size 1024 -Path C:\config.xml</dev:code> <dev:remarks> <maml:para>This command creates a local cache named demoCache of size 1024 MB on server 20.200.21.11, with the configuration that exists on the specified path.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>New-Cache -Name demoCache -Server 20.200.21.11 -Size 1024 -Topology replicated -ClusterPort 8701</dev:code> <dev:remarks> <maml:para>This command creates new cache named demoCache on server 20.200.21.11 having size 1024 MB and topology replicated and occupying the port 8701 for simple case.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>New-Cache -Name demoCache -Server 20.200.21.11 -Size 1024 -Topology partitioned -DefaultPriority high -EvictionRatio 10 -CleanupInterval 20 -ClusterPort 8701</dev:code> <dev:remarks> <maml:para>This command creates new cache named demoCache on server 20.200.21.11 having size 1024 MB, topology partitioned, default priority high, eviction ratio 10%, clean interval 20, occupying cluster port 8701.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>New-Cache -Name demoCache -Server "20.200.21.11,20.200.21.12" -Size 1024 -Topology replicated -ClusterPort 8701</dev:code> <dev:remarks> <maml:para>This command creates new cache named demoCache on servers 20.200.21.11 and 20.200.21.12 having size 1024 MB and topology replicated and occupying the port 8701 for simple case.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-Cache --> <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>Remove-Cache</command:name> <maml:description> <maml:para>Removes the registered cache.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>Cache</command:noun> </command:details> <command:description> <maml:para>Remove-Cache cmdlet enables the user to remove an already registered cache.</maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-Cache</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies name of cache that has to be removed. Cache must exist on source server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies a server name where the NCache service is running and a cache with the specified cache-name is registered. Cache configuration is copied from this server to the destination server. The default is the local machine</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on which NCache server is listening. Default port is 8250.</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>8250</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-Cache -Name demoCache</dev:code> <dev:remarks> <maml:para>This command removes the demoCache from local server.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Remove-Cache -Name demoCache -Server 20.200.21.11</dev:code> <dev:remarks> <maml:para>This command removes the demoCache from server 20.200.21.11.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Remove-Cache -Name demoCache -Server 20.200.21.11 -Port 8250</dev:code> <dev:remarks> <maml:para>This command uses port also and removes the demoCache from server 20.200.21.11.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-Cache --> <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>Start-Cache</command:name> <maml:description> <maml:para>Starts the registered cache.</maml:para> </maml:description> <command:verb>Start</command:verb> <command:noun>Cache</command:noun> </command:details> <command:description> <maml:para>Start-Cache cmdlet starts the registered cache. If nodes are mentioned, the cache process is only started on given nodes. </maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Start-Cache</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8250</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more name(s) of caches separated by comma registered on the server. The cache(s) with this/these name(s) is/are started on the server. Note: Comma-separated cache names are to be specified in case of multiple caches</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: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies a server name where the NCache service is running. The default is the local machine</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: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on which NCache server is listening. Default port is 8250</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8250</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>The following command starts cache on local server</maml:paragraph> </maml:introduction> <dev:code>Start-Cache -Name demoCache</dev:code> <dev:remarks> <maml:para>This command starts cache named demoCache on local server.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Start-Cache -Name demoCache -Server 20.200.21.11</dev:code> <dev:remarks> <maml:para>This command starts cache named demoCache existing on server 20.200.21.11.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Start-Cache -Name demoCache -Server 20.200.21.11 -Port 8250</dev:code> <dev:remarks> <maml:para>This command uses port and starts cache named demoCache existing on server 20.200.21.11.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Stop-Cache --> <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>Stop-Cache</command:name> <maml:description> <maml:para>Stops the registered cache.</maml:para> </maml:description> <command:verb>Stop</command:verb> <command:noun>Cache</command:noun> </command:details> <command:description> <maml:para>Stop-Cache cmdlet enables users to stop a cache.</maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Stop-Cache</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <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="true (ByPropertyName)" position="named"> <maml:name>Timeout</maml:name> <command:parameterValue required="false">int</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more name(s) of caches separated by comma registered on the server. The cache(s) with this/these name(s) is/are stopped on the server. Note: Comma-separated cache names are to be specified in case of multiple caches</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies a server name where the NCache service is running. The default is the local machine.</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="true (ByValue, ByPropertyName)" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifies the interval cache is going under maintenance for. Maintenance timeout must range from 0 to 600 minutes.</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>0</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on which NCache server is listening. Default port is 8250.</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>8250</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Stop-Cache -Name demoCache</dev:code> <dev:remarks> <maml:para>This command stops demoCache on local server.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Stop-Cache -Name demoCache -Server 20.200.21.11</dev:code> <dev:remarks> <maml:para>This command stops demoCache on sever 20.200.21.11</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Export-CacheConfiguration --> <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>Export-CacheConfiguration</command:name> <maml:description> <maml:para>Gets the configuration of cache(s).</maml:para> </maml:description> <command:verb>Export</command:verb> <command:noun>CacheConfiguration</command:noun> </command:details> <command:description> <maml:para>Export-CacheConfiguration cmdlet enables the user to copy the configuration of the specified cache. This cmdlet copies complete config.ncconf if no cache is specified. </maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Export-CacheConfiguration</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Path</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Path --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path where config will be generated.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cache for which cache configuration will be generated.</maml:para> </maml:description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the NCache server name/ip.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on which NCache server is listening. Default port is 8250.</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>8250</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Export-CacheConfiguration -Name demoCache -Server 20.200.21.11 -Path C:\Desktop\config.xml</dev:code> <dev:remarks> <maml:para>This command generates the configuration file for the demoCache on specified path</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Export-CacheConfiguration -Name demoCache -Server 20.200.21.11 -Path C:\Desktop\config.xml -Port 8250</dev:code> <dev:remarks> <maml:para>This command uses port also to generate the configuration file for the demoCache on specified path</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Export-CacheConfiguration -Server 20.200.21.11 -Path C:\Desktop\config.xml</dev:code> <dev:remarks> <maml:para>This command generates complete configuration file for the server 20.200.21.11 on specified path</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CacheCount --> <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-CacheCount</command:name> <maml:description> <maml:para>Gets the cache count.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>CacheCount</command:noun> </command:details> <command:description> <maml:para>Get-CacheCount cmdlet enables the user to get the total count of items present in the cache.</maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CacheCount</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the cache for which you want to use this tool.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies one or more ip-address(es) for one or more cache-server(s). This option can be used to customize the list of ip-address(es) to be displayed. Note: Comma separated ip-addresses are to be specified in case of multiple servers inside double quotes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-CacheCount -Name demoCache</dev:code> <dev:remarks> <maml:para>This command displays total numbers of items currently in cache. This command reads deployment details specified in client.ncconf</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-CacheCount -Name demoCache -Servers "20.200.20.11,20.200.20.10"</dev:code> <dev:remarks> <maml:para>This command displays total numbers of items currently in cache. This command ignores deployment details specified in client.ncconf</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Export-CacheKeys --> <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>Export-CacheKeys</command:name> <maml:description> <maml:para>Dumps keys in cache.</maml:para> </maml:description> <command:verb>Export</command:verb> <command:noun>CacheKeys</command:noun> </command:details> <command:description> <maml:para>Export-CacheKeys cmdlet enables the user to dump keys to the console currently present in the cache.</maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Export-CacheKeys</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: KeyCount --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>KeyCount</maml:name> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1000</dev:defaultValue> </command:parameter> <!-- Parameter: KeyFilter --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>KeyFilter</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies id of cache to be dumped.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: KeyCount --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>KeyCount</maml:name> <maml:description> <maml:para>Specifies the number of keys. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1000</dev:defaultValue> </command:parameter> <!-- Parameter: KeyFilter --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>KeyFilter</maml:name> <maml:description> <maml:para>Specifies the keys that contain this substring. By default it is empty.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Export-CacheKeys -Name demoCache</dev:code> <dev:remarks> <maml:para>This command dumps the 1000 keys currently present in the cache</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Export-CacheKeys -Name demoCache -KeyCount 500</dev:code> <dev:remarks> <maml:para>This command dumps the 500 keys currently present in the cache.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Export-CacheKeys -Name demoCache -KeyCount 500 -KeyFilter 11</dev:code> <dev:remarks> <maml:para>This command dumps the 500 keys currently present in the cache containing 11 as substring in keys.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-Caches --> <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-Caches</command:name> <maml:description> <maml:para>Lists the registered caches.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>Caches</command:noun> </command:details> <command:description> <maml:para>Get-Caches cmdlet enables the user to list the total caches registered on the server and there status.</maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-Caches</maml:name> <!-- Parameter: Detail --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Detail</maml:name> <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> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies a server name where the NCache service is running. The default is the local machine</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on which NCache server is listening. Default port is 8250.</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>8250</dev:defaultValue> </command:parameter> <!-- Parameter: Detail --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Detail</maml:name> <maml:description> <maml:para>Displays detailed information about the cache(s) registered on the server.</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> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-Caches</dev:code> <dev:remarks> <maml:para>This command displays all caches registered on local machine.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Get-Caches -Detail -Server 20.200.21.11</dev:code> <dev:remarks> <maml:para>This command displays all caches currently registered on the provided server with detailed information.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Get-Caches -Detail</dev:code> <dev:remarks> <maml:para>This command displays all caches currently registered on the server with detailed information.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-ClientNode --> <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>Add-ClientNode</command:name> <maml:description> <maml:para>Adds client node.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>ClientNode</command:noun> </command:details> <command:description> <maml:para>Add-ClientNode cmdlet enable users to add client nodes to the existing clustered cache(s).</maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-ClientNode</maml:name> <!-- Parameter: CacheName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: AcquireServerMapping --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AcquireServerMapping</maml:name> <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> <!-- Parameter: ClientNode --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientNode</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: UpdateServerConfig --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UpdateServerConfig</maml:name> <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: CacheName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <maml:description> <maml:para>Specifies the name of the clustered cache. Cache must exist on source server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies a server name where the NCache service is running and a cache with the specified cache-name is registered.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ClientNode --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientNode</maml:name> <maml:description> <maml:para>Specifies a client node (node to be added as client node) where the NCache service is running.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on which NCache server is listening. Default port is 8250.</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>8250</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateServerConfig --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UpdateServerConfig</maml:name> <maml:description> <maml:para>Specifies whether to update the client-nodes sections of server node(s) of the specified cluster. The default value is true.(Useful when cluster nodes and clients are in different networks)</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>True</dev:defaultValue> </command:parameter> <!-- Parameter: AcquireServerMapping --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AcquireServerMapping</maml:name> <maml:description> <maml:para>Specifies whether to fetch the server mapping list from the server node(s). The default value is false. (Useful when cluster nodes and clients are in different networks).</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> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-ClientNode -CacheName demoCache -Server 20.200.21.11 -ClientNode 20.200.21.12</dev:code> <dev:remarks> <maml:para>This command adds a client node 20.200.21.12 to the demoCache which exists on server 20.200.20.11.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Add-ClientNode -CacheName demoCache -Server 20.200.21.11 -ClientNode 20.200.21.12 -Port 8250</dev:code> <dev:remarks> <maml:para>This command adds a client node 20.200.21.12 to the demoCache which exists on server 20.200.20.11 while specifying port-number.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Add-ClientNode -CacheName demoCache -Server 20.200.21.11 -ClientNode 20.200.21.12 -UpdateServerConfig</dev:code> <dev:remarks> <maml:para>This command adds a client node 20.200.21.12 to the demoCache which exists on server 20.200.20.11 while specifying port-number and not updating server config.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-ClientNode --> <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>Remove-ClientNode</command:name> <maml:description> <maml:para>Removes client node.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>ClientNode</command:noun> </command:details> <command:description> <maml:para>Remove-ClientNode cmdlet enables users to remove client nodes from the existing clustered caches.</maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-ClientNode</maml:name> <!-- Parameter: Cachename --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Cachename</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ClientNode --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientNode</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Cachename --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Cachename</maml:name> <maml:description> <maml:para>Specifies id of Clustered Cache. Cache must exist on source server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies a server name where the NCache service is running and a cache with the specified cache-name is registered. Cache configuration is copied from this server to the destination server. The default is the local machine</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ClientNode --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientNode</maml:name> <maml:description> <maml:para>Specifies a client node where the NCache service is running.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on which NCache server is listening. Default port is 8250.</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>8250</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-ClientNode -CacheName demoCache -ClientNode 20.200.21.12</dev:code> <dev:remarks> <maml:para>This command removes client node 20.200.21.12 from the demoCache.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Remove-ClientNode -CacheName demoCache -ClientNode 20.200.21.12 -Server 20.200.21.11</dev:code> <dev:remarks> <maml:para>This command removes a client node 20.200.21.12 from the demoCache which exists on server 20.200.20.11.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Remove-ClientNode -CacheName demoCache -ClientNode 20.200.21.12 -Server 20.200.21.11 -Port 8250</dev:code> <dev:remarks> <maml:para>This command uses port also and removes a client node 20.200.21.12 from the demoCache which exists on server 20.200.20.11.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-TestData --> <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>Add-TestData</command:name> <maml:description> <maml:para>Adds test data.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>TestData</command:noun> </command:details> <command:description> <maml:para>Add-TestData cmdlet adds test data to the specified cache. </maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-TestData</maml:name> <!-- Parameter: CacheName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: AbsoluteExpiration --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AbsoluteExpiration</maml:name> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>300</dev:defaultValue> </command:parameter> <!-- Parameter: DataSize --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DataSize</maml:name> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1024</dev:defaultValue> </command:parameter> <!-- Parameter: ItemCount --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ItemCount</maml:name> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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: CacheName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <maml:description> <maml:para>Specifies the name of the cache for which you want to use this tool.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ItemCount --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ItemCount</maml:name> <maml:description> <maml:para>Number of items to be added to the cache. By default 10 items are added to the cache</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies one or more ip-address(es) for one or more cache-server(s). This option can be used to customize the list of ip-address(es) to be displayed. Note: Comma separated ip-addresses are to be specified in case of multiple servers inside double quotes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DataSize --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DataSize</maml:name> <maml:description> <maml:para>Size in bytes of each item to be added to the cache. By default items of 1k (1024 bytes) are added to the cache.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1024</dev:defaultValue> </command:parameter> <!-- Parameter: AbsoluteExpiration --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AbsoluteExpiration</maml:name> <maml:description> <maml:para>Specify in seconds, absolute expiration (default: 300; minimum: 15)</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>300</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-TestData -CacheName demoCache</dev:code> <dev:remarks> <maml:para>This command adds 10 items to the demoCache with expiry of 5 minutes.This command reads deployment details specified in client.ncconf</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Add-TestData -CacheName demoCache -ItemCount 100</dev:code> <dev:remarks> <maml:para>This command adds 100 items to the demoCache with expiry of 5 minutes.This command reads deployment details specified in client.ncconf</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Add-TestData -CacheName demoCache -ItemCount 100 -DataSize 2048</dev:code> <dev:remarks> <maml:para>This command 100 items of size 2KB to the demoCache with expiry of 5 minutes.This command reads deployment details specified in client.ncconf</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Add-TestData -CacheName demoCache -ItemCount 100 -Servers "20.200.20.11,20.200.20.12"</dev:code> <dev:remarks> <maml:para>This command adds 100 items to the demoCache with expiry of 5 minutes.This command ignores deployment details specified in client.ncconf</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-NCacheVersion --> <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-NCacheVersion</command:name> <maml:description> <maml:para>Verifies license.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>NCacheVersion</command:noun> </command:details> <command:description> <maml:para>Get-NCacheVersion cmdlet enables the user to verify the NCache License. For registered version it will display the registration details. In evaluation mode it will display the remaining day if evaluation is still valid else give the expiration message.. Information about a remote NCache installation can also be fetched using this cmdlet.</maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-NCacheVersion</maml:name> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8250</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies a server name where the NCache service is running. The default is the local machine</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: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on which NCache server is listening. Default port is 8250</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8250</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-NCacheVersion</dev:code> <dev:remarks> <maml:para>This command displays registration details.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-NCacheVersion -Server 10.0.2.5</dev:code> <dev:remarks> <maml:para>This command displays registration details of machine 10.0.2.5.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-NCacheVersion -Server 10.0.2.5 -Port 8250</dev:code> <dev:remarks> <maml:para>This command displays registration details of machine 10.0.2.5 on management port 8250 where NCache Service is running.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Get-NCacheVersion -NoLogo</dev:code> <dev:remarks> <maml:para>This command displays registration details without displaying logo banner.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Invoke-MonitorServer --> <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>Invoke-MonitorServer</command:name> <maml:description> <maml:para>Invokes monitoring.</maml:para> </maml:description> <command:verb>Invoke</command:verb> <command:noun>MonitorServer</command:noun> </command:details> <command:description> <maml:para>Invoke-MonitorServer cmdlet enables the user to start and stop monitoring the activities performed on the server and log these activities in a log file. </maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Invoke-MonitorServer</maml:name> <!-- Parameter: Action --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Action</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Action --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Action</maml:name> <maml:description> <maml:para>Specifies the action i.e start or stop.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies a server name where the NCache service is running.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on which NCache server is listening. Default port is 8250.</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>8250</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses the logo banner.</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></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-MonitorServer -Action start</dev:code> <dev:remarks> <maml:para>This command starts the monitoring server.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Invoke-MonitorServer -Action stop</dev:code> <dev:remarks> <maml:para>This command stops the monitoring server.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Invoke-MonitorServer -Action start -Server 20.200.21.11</dev:code> <dev:remarks> <maml:para>This command starts monitoring the server on node 20.200.21.11.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-Node --> <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>Add-Node</command:name> <maml:description> <maml:para>Adds server node to cache cluster.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>Node</command:noun> </command:details> <command:description> <maml:para>Add-Node cmdlet enables users to add a new server node to the existing clustered cache.</maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-Node</maml:name> <!-- Parameter: CacheName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ExistingServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ExistingServer</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NewServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewServer</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: CacheName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <maml:description> <maml:para>Specifies name of Clustered Cache .Cache must exist on source server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ExistingServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ExistingServer</maml:name> <maml:description> <maml:para>Specifies a server name where the NCache service is running and a cache with the specified cache-name is registered. Cache configuration is copied from this server to the destination server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NewServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewServer</maml:name> <maml:description> <maml:para>Specifies a server name where a cache with the specified cache-name needs to be registered. The cache configuration is copied from the source server name to this server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on which NCache server is listening. Default port is 8250.</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>8250</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses the logo banner.</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></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-Node -CacheName demoCache -ExistingServer 20.200.20.11 -NewServer 20.200.21.12</dev:code> <dev:remarks> <maml:para>This command adds a new node 20.200.21.12 to the cache existing on server 20.200.21.11.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-Node --> <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>Remove-Node</command:name> <maml:description> <maml:para>Removes server node.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>Node</command:noun> </command:details> <command:description> <maml:para>Remove-Node cmdlet enables users to remove node from existing cache.</maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-Node</maml:name> <!-- Parameter: CacheName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: CacheName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <maml:description> <maml:para>Specifies id of cache registered on the server. The cache with this id is unregistered on the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies a server name where the NCache service is running. This server will be removed from specified cache. The default is the local machine</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on which NCache server is listening. Default port is 8250.</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>8250</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Supresses the logo banner.</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></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-Node -CacheName demoCache</dev:code> <dev:remarks> <maml:para>This command removes local node from the demoCache.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Remove-Node -CacheName demoCache -Server 20.200.21.12</dev:code> <dev:remarks> <maml:para>This command removes node 20.200.21.12 from the demoCache.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Invoke-ServerLogger --> <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>Invoke-ServerLogger</command:name> <maml:description> <maml:para>Invokes server logging.</maml:para> </maml:description> <command:verb>Invoke</command:verb> <command:noun>ServerLogger</command:noun> </command:details> <command:description> <maml:para>Invoke-ServerLogger cmdlet is used to enable detailed logging for both socket-server and all the clients.</maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Invoke-ServerLogger</maml:name> <!-- Parameter: Disable --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Disable</maml:name> <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> <!-- Parameter: Enable --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Enable</maml:name> <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> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Enable --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Enable</maml:name> <maml:description> <maml:para>Enables error and detailed logging.</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> <!-- Parameter: Disable --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Disable</maml:name> <maml:description> <maml:para>Disables error and detailed logging.</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> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the NCache server name/ip.</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: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on which NCache server is listening. Default port is 8250.</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>8250</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-ServerLogger -Enable</dev:code> <dev:remarks> <maml:para>This command enables socket-server logs.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Invoke-ServerLogger -Disable</dev:code> <dev:remarks> <maml:para>This command disables socket-server logs</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Test-Stress --> <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>Test-Stress</command:name> <maml:description> <maml:para>Starts stress test tool.</maml:para> </maml:description> <command:verb>Test</command:verb> <command:noun>Stress</command:noun> </command:details> <command:description> <maml:para>Test-Stress cmdlet enables users to quickly simulate heavy transactional load on a given cache. And, this helps you see how NCache actually performs under stress in your own environment. Please watch NCache performance counters in NCache Manager "statistics" or regular PerfMon.</maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Test-Stress</maml:name> <!-- Parameter: CacheName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DataSize --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DataSize</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1024</dev:defaultValue> </command:parameter> <!-- Parameter: GetsPerIteration --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GetsPerIteration</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: ItemsCount --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ItemsCount</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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> <!-- Parameter: ReportingInterval --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ReportingInterval</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5000</dev:defaultValue> </command:parameter> <!-- Parameter: SlidingExpiration --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SlidingExpiration</maml:name> <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: TestCaseIterationDelay --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TestCaseIterationDelay</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: TestCaseIterations --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TestCaseIterations</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <!-- Parameter: ThreadCount --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ThreadCount</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: UpdatesPerIteration --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UpdatesPerIteration</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: CacheName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <maml:description> <maml:para>Specifies name of the cache.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies one or more ip-address(es) for one or more cache-server(s). This option can be used to customize the list of ip-address(es) to be displayed. Note: Comma separated ip-addresses are to be specified in case of multiple servers inside double quotes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ItemsCount --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ItemsCount</maml:name> <maml:description> <maml:para>Specifies how many total items you want to add. (default: infinite)</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>0</dev:defaultValue> </command:parameter> <!-- Parameter: TestCaseIterations --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TestCaseIterations</maml:name> <maml:description> <maml:para>Specifies how many iterations within a test case (default: 20)</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>20</dev:defaultValue> </command:parameter> <!-- Parameter: TestCaseIterationDelay --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TestCaseIterationDelay</maml:name> <maml:description> <maml:para>Specifies how much delay (in seconds) between each test case iteration (default: 0)</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>0</dev:defaultValue> </command:parameter> <!-- Parameter: GetsPerIteration --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GetsPerIteration</maml:name> <maml:description> <maml:para>Specifies how many gets within one iteration of a test case (default: 1)</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>1</dev:defaultValue> </command:parameter> <!-- Parameter: UpdatesPerIteration --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UpdatesPerIteration</maml:name> <maml:description> <maml:para>Specifies how many updates within one iteration of a test case (default: 1)</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>1</dev:defaultValue> </command:parameter> <!-- Parameter: DataSize --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DataSize</maml:name> <maml:description> <maml:para>Specifies in bytes the size of each cache item (default: 1024)</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>1024</dev:defaultValue> </command:parameter> <!-- Parameter: SlidingExpiration --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SlidingExpiration</maml:name> <maml:description> <maml:para>Specifies in seconds sliding expiration (default: 300; minimum: 15)</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: ThreadCount --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ThreadCount</maml:name> <maml:description> <maml:para>Specifies how many client threads (default: 1; maximum: 3)</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>1</dev:defaultValue> </command:parameter> <!-- Parameter: ReportingInterval --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ReportingInterval</maml:name> <maml:description> <maml:para>Report after this many total iterations (default: 5000)</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>5000</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Test-Stress -CacheName demoCache</dev:code> <dev:remarks> <maml:para>This command executes stresstesttool on demoCache.This command reads deployment details specified in client.ncconf</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Test-Stress -CacheName demoCache -DataSize 2048</dev:code> <dev:remarks> <maml:para>This command executes stresstesttool on demoCache and will add items of size 2kb. This command reads deployment details specified in client.ncconf</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Test-Stress -CacheName demoCache -DataSize 2048 -Servers "20.200.20.11,20.200.20.10"</dev:code> <dev:remarks> <maml:para>This command executes stresstesttool on demoCache and will add items of size 2kb. This command ignores deployment details specified in client.ncconf</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-Topics --> <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-Topics</command:name> <maml:description> <maml:para>Gets topics registered on cache.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>Topics</command:noun> </command:details> <command:description> <maml:para>Get-Topics cmdlet lists all topics registered on specified cache. It displays the topic names, messages, subscribers and publishers.</maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-Topics</maml:name> <!-- Parameter: CacheName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Detail --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>ShowAll</maml:name> <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> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8250</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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: CacheName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <maml:description> <maml:para>Specifies the cache name for which topics have to be listed.</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: ShowAll --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>ShowAll</maml:name> <maml:description> <maml:para>Specifies the default and user created topics to be included in result.</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> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies a server name where the NCache service is running. The default is the local machine</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: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on which NCache server is listening. Default port is 8250</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8250</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-Topics -CacheName demoCache</dev:code> <dev:remarks> <maml:para>This command gets topics registered on demoCache.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Get-Topics -CacheName demoCache -Server 20.200.21.11</dev:code> <dev:remarks> <maml:para>This command gets topics registered on demoCache existing on server 20.200.21.11.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Get-Topics -CacheName demoCache -Server 20.200.21.11 -Port 8250</dev:code> <dev:remarks> <maml:para>This command uses port and gets topics registered on demoCache existing on server 20.200.21.11.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Get-Topics -CacheName demoCache -ShowAll </dev:code> <dev:remarks> <maml:para>This command shows all the topics including default and user created both.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Register-NCache --> <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>Register-NCache</command:name> <command:verb>Register</command:verb> <command:noun>NCache</command:noun> </command:details> <command:description> <maml:para>Register-Ncache cmdlet registers the NCache installed on machine. </maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Register-NCache</maml:name> <!-- Parameter: Key --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Key</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Environment --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Environment</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Clients --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Clients</maml:name> <command:parameterValue required="false">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Address</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: City --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>City</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Company --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Company</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Country --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Country</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Email --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Email</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FirstName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>FirstName</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LastName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>LastName</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ManualActivate --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Address</maml:name> <command:parameterValue required="false">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Phone --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Phone</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Reactivate --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Reactivate</maml:name> <command:parameterValue required="false">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: State --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>State</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ZipCode --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>ZipCode</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AuthCode --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>AuthCode</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8250</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Key --> <command:parameter required="false" globbing="false" pipelineInput="false (ByValue, ByPropertyName)" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para> Specifies the license key or cloud activation key received from Alachisoft.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Environment --> <command:parameter required="false" globbing="false" pipelineInput="false (ByValue, ByPropertyName)" position="named"> <maml:name>Environment</maml:name> <maml:description> <maml:para> Environment name for which the machine is been activated should be specified here. Only required at the time of activation/re-activation.</maml:para> </maml:description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Clients --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Clients</maml:name> <maml:description> <maml:para> Number of client licenses needs to be activated with the specified environment. Only required at the time of activation/re-activation for Client-Server licensing.</maml:para> </maml:description> <command:parameterValue required="false">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: FirstName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>Specifies User's First name to be register .</maml:para> </maml:description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: LastName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>Specifies User's Last name to be register .</maml:para> </maml:description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Email --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Email</maml:name> <maml:description> <maml:para>Specifies User's Email to be register .</maml:para> </maml:description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Company --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Company</maml:name> <maml:description> <maml:para>Specifies User's Company Name to be register .</maml:para> </maml:description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: AuthCode --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>AuthCode</maml:name> <maml:description> <maml:para>Auth Code provided by Alachisoft support department for manual activation.</maml:para> </maml:description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Address --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Address</maml:name> <maml:description> <maml:para>Specifies User's Address to be register .</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: City --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>City</maml:name> <maml:description> <maml:para>Specifies User's City to be register .</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: State --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies User's State to be register .</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Country --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Country</maml:name> <maml:description> <maml:para>Specifies User's Country to be register .</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Phone --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Phone</maml:name> <maml:description> <maml:para>Specifies User's Phone number to be register .</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ZipCode --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>ZipCode</maml:name> <maml:description> <maml:para>Specifies User's ZipCode to be register .</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies a server name where the NCache service is running. The default is the local machine</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Reactivate --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Reactivate</maml:name> <maml:description> <maml:para>to reactivate an existing activation</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> <!-- Parameter: ManualActivate --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ManualActivate</maml:name> <maml:description> <maml:para>To manually activate NCache</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> <!-- Parameter: UserId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Specifies the UserId that is used to authorize the user if security is enabled on the cache server. This UserId must be same as the active directory user credentials.</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: Password --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password for user authorisation if security is enabled on cache server. This password must be the same as active directory password.</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: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>The following command activates NCache using NCache license key on local server with 'production' environment.</maml:paragraph> </maml:introduction> <dev:code>Register-NCache -Key xxxxxxxx-xxxxxx-xxxxxxxx -FirstName Paul -LastName Jones -Email paul.jones@alachisoft.com -Company alachisoft -Environment production</dev:code> <dev:remarks> <maml:para>This command registers NCache on local server with the given NCache license key for environment 'production'.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>The following command activates NCache using NCache license key on server 20.200.21.11 with 'production' environment.</maml:paragraph> </maml:introduction> <dev:code>Register-NCache -Key xxxxxxxx-xxxxxx-xxxxxxxx -FirstName Paul -LastName Jones -Email paul.jones@alachisoft.com -Company alachisoft -Server 20.200.21.11 -Environment production</dev:code> <dev:remarks> <maml:para>This command registers NCache on server 20.200.21.11 with the given NCache license key for environment 'production'.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>The following command reactivates NCache using NCache license key on already activated machine on server 20.200.21.11 for 'production' environment.</maml:paragraph> </maml:introduction> <dev:code>Register-NCache -Key xxxxxxxx-xxxxxx-xxxxxxxx -FirstName Paul -LastName Jones -Email paul.jones@alachisoft.com -Company alachisoft -Server 20.200.21.11 -Reactivate -Environment production</dev:code> <dev:remarks> <maml:para>This command reactivates NCache on already activated machine using NCache license key for environment 'production'.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>The following command returns the encrypted code for manually registering NCache.</maml:paragraph> </maml:introduction> <dev:code>Register-NCache -Key xxxxxxxx-xxxxxx-xxxxxxxx -FirstName Paul -LastName Jones -Email paul.jones@alachisoft.com -Company alachisoft -Server 20.200.21.11 -ManualActivate -Environment production</dev:code> <dev:remarks> <maml:para>This command returns the encrypted code for manually registerng with NCache using NCache license key.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <maml:introduction> <maml:paragraph>The following command activates NCache using AuthCode received from Alachisoft.</maml:paragraph> </maml:introduction> <dev:code>Register-NCache -AuthCode xxxxxxxxxxxxxx -ManualActivate</dev:code> <dev:remarks> <maml:para>This command registers NCache on local server with the given AuthCode received from Alachisoft.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Unregister-NCache --> <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>Unregister-NCache</command:name> <command:verb>Unregister</command:verb> <command:noun>NCache</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Unregister-NCache</maml:name> <!-- Parameter: Key --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Key</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ManualDeactivate --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ManualDeactivate</maml:name> <maml:description> <maml:para>To manually deactivate NCache</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> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Key --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Key</maml:name> <maml:description> <maml:para>Deactivation key on which deactivation is to be made.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies a server name where the NCache service is running. The default is the local machine</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8250</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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>True</dev:defaultValue> </command:parameter> <!-- Parameter: ManualDeactivate --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ManualDeactivate</maml:name> <maml:description> <maml:para>To manually deactivate NCache.</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>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>The following command De-Activate cache on local server </maml:paragraph> </maml:introduction> <dev:code>Unregister-NCache -Key xxxxxxxxxxxx</dev:code> <dev:remarks> <maml:para>This command Deactivate NCache on local server.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Unregister-NCache -Key xxxxxxxxxxxx -Server 20.200.21.11</dev:code> <dev:remarks> <maml:para>This command Deactivate NCache on server 20.200.21.11.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Unregister-NCache -Key xxxxxxxxxxxx -ManualDeactivate</dev:code> <dev:remarks> <maml:para>This command returns the encrypted code for manually unregistering NCache. This code needs to be mailed to Alachisoft support team in order to unregister.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Send-Heartbeat --> <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>Send-Heartbeat</command:name> <maml:description> <maml:para>Sends a forced heartbeat to cloud.alachisoft.com from the target machine.</maml:para> </maml:description> <command:verb>Send</command:verb> <command:noun>Heartbeat</command:noun> </command:details> <command:description> <maml:para>Send-Heartbeat cmdlet sends a forced heartbeat to cloud.alachisoft.com from a cloud activated machine.</maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Send-Heartbeat </maml:name> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies a server name where the NCache service is running. The default is the local machine</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: UserId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Specifies the UserId that is used to authorize the user if security is enabled on the cache server. This UserId must be same as the active directory user credentials.</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: Password --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password for user authorisation if security is enabled on cache server. This password must be the same as active directory password.</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:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>The following command sends a forced heartbeat from lcoal machine to cloud.alachisoft.com from a cloud activated machine.</maml:paragraph> </maml:introduction> <dev:code>Send-Heartbeat</dev:code> <dev:remarks> <maml:para>This command sends a forced heartbeat from local server.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Send-Heartbeat -Server 20.200.21.11</dev:code> <dev:remarks> <maml:para>This command sends a forced heartbeat existing on server 20.200.21.11.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-ClusterHealth --> <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-ClusterHealth</command:name> <maml:description> <maml:para>Gets cluster state on cache.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>ClusterHealth</command:noun> </command:details> <command:description> <maml:para>Get-ClusterHealth cmdlet displays all the nodes registered on specified cache. It displays the status, number of connected clients and connection information of the cache.</maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ClusterHealth</maml:name> <!-- Parameter: CacheName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Continuous --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Continuous</maml:name> <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> <!-- Parameter: SampleInterval --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SampleInterval</maml:name> <command:parameterValue required="true">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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: CacheName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <maml:description> <maml:para>Specifies the cache name for which cluster health status will be fetched.</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: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies a server IP Address where the NCache service is running. The default is the local machine.</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: Continuous --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Continuous</maml:name> <maml:description> <maml:para>Indicates that this cmdlet gets statistics continuously. By default, this cmdlet gets statistics only once. You can use the SampleInterval parameter to set the interval for continuous sampling.</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> <!-- Parameter: SampleInterval --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SampleInterval</maml:name> <maml:description> <maml:para>Specifies the time between samples in seconds. The default value is 3 seconds. Minimum value is 1.</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>3</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-ClusterHealth -CacheName demoCache</dev:code> <dev:remarks> <maml:para>This command gets the nodes, status, connection information and connected clients count for 'demoCache'.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Get-ClusterHealth -CacheName demoCache -Server 20.200.21.11</dev:code> <dev:remarks> <maml:para>This command gets the nodes, status, connection information and connected clients count for 'demoCache' on the Server '20.200.21.11' . </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Get-ClusterHealth -CacheName demoCache -Continuous</dev:code> <dev:remarks> <maml:para>This command gets the nodes, status, connection information and connected clients count for 'demoCache' continuously after every 3 seconds.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Get-ClusterHealth -CacheName demoCache -Continuous -SampleInterval 5</dev:code> <dev:remarks> <maml:para>This command gets the nodes, status, connection information and connected clients count for 'demoCache' continuously after every 5 seconds.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CacheServerStatistics --> <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> <maml:description> <maml:para>Gets statistics of the cache.</maml:para> </maml:description> <command:name>Get-CacheServerStatistics</command:name> <command:verb>Get</command:verb> <command:noun>CacheServerStatistics</command:noun> </command:details> <command:description> <maml:para>Get-CacheServerStatistics cmdlet displays the value of performance counters for a given cache on one or more cache servers. The list of counters that this cmdlet displays can be customized. </maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CacheServerStatistics</maml:name> <!-- Parameter: CacheName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Servers --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Servers</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: CounterNames --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>CounterNames</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DoNotShowDefaultCounters --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DoNotShowDefaultCounters</maml:name> <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> <!-- Parameter: Format --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Format</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Continuous --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Continuous</maml:name> <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> <!-- Parameter: SampleInterval --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SampleInterval</maml:name> <command:parameterValue required="true">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaxSamples --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaxSamples</maml:name> <command:parameterValue required="true">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: CacheName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <maml:description> <maml:para>Specifies the name of the cache for which counters will be fetched.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Servers --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Servers</maml:name> <maml:description> <maml:para> Specifies one or more server IP Address(es) where the NCache service is running as well as the cache with the specified name is running. The default is the local machine. Note: Comma separated server names are to be specified in case of multiple servers inside double quotes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: CounterNames --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>CounterNames</maml:name> <maml:description> <maml:para> Specifies one or more cache counter name(s) for which the values should be displayed. This option can be used to customize the list of counters to be displayed. Note: Comma separated counter names are to be specified in case of multiple counters inside double quotes. For a complete list of NCache counters, please visit http://www.alachisoft.com/resources/docs/ncache/admin-guide/cache-counters.html. </maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Format --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Format</maml:name> <maml:description> <maml:para>Specifies how the values of counters should be displayed. By default, its Tabular. CSV is recommended for output redirection to a file. CSV format can be converted to .blg which can be opened in Windows Performance Monitor.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DoNotShowDefaultCounters --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DoNotShowDefaultCounters</maml:name> <maml:description> <maml:para> Indicates that this cmdlet doesn't display the default counters. This should only be used when -CounterNames parameter is used.</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> <!-- Parameter: Continuous --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Continuous</maml:name> <maml:description> <maml:para>Indicates that this cmdlet gets statistics continuously. By default, this cmdlet gets statistics only once. You can use the SampleInterval parameter to set the interval for continuous sampling.</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> <!-- Parameter: SampleInterval --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SampleInterval</maml:name> <maml:description> <maml:para> Specifies the time between samples in seconds.The default value is 3 seconds. Minimum value is 1.</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>3</dev:defaultValue> </command:parameter> <!-- Parameter: MaxSamples --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaxSamples</maml:name> <maml:description> <maml:para> Specifies the number of samples to get from each counter. The default is 1 sample. To get samples continuously (no maximum sample size), use the Continuous parameter. </maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-CacheServerStatistics -CacheName demoCache</dev:code> <dev:remarks> <maml:para>This command gets default counters for 'democache' from the local node.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Get-CacheServerStatistics -CacheName demoCache -Servers "20.200.21.19,20.200.21.20"</dev:code> <dev:remarks> <maml:para>This command gets default counters for 'democache' from the given two server nodes.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Get-CacheServerStatistics -CacheName demoCache -Servers "20.200.21.19,20.200.21.20" -CounterNames "Hits/sec, Misses/sec"</dev:code> <dev:remarks> <maml:para>This command gets values of specified counter names along side the default counters for 'democache'.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Get-CacheServerStatistics -CacheName demoCache -Servers "20.200.21.19,20.200.21.20" -CounterNames "Hits/sec, Misses/sec" -MaxSamples 50</dev:code> <dev:remarks> <maml:para>This command gets the 50 samples from defined counters for 'democache'.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code> Get-CacheServerStatistics -CacheName demoCache -Servers "20.200.21.19,20.200.21.20" -CounterNames "Hits/sec, Misses/sec" -DoNotShowDefaultCounters</dev:code> <dev:remarks> <maml:para>This command gets values of specified counter names for 'democache'. It does not display the values of default counters.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code> Get-CacheServerStatistics -CacheName demoCache -Servers "20.200.21.19,20.200.21.20" -Continuous</dev:code> <dev:remarks> <maml:para>This command gets values of counters for 'democache' continuously after every 3 seconds. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 7 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code> Get-CacheServerStatistics -CacheName demoCache -Servers "20.200.21.19,20.200.21.20" -Continuous -SampleInterval 5</dev:code> <dev:remarks> <maml:para>This command gets values of counters for 'democache' continuously after every 5 seconds.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 8 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Get-CacheServerStatistics -CacheName demoCache -Continuous -SampleInterval 1 -Format CSV | Out-File -Encoding ASCII "C:\stats.csv"</dev:code> <dev:remarks> <maml:para>This command gets values of default counters for 'democache' continuously after every 3 seconds and saves the output in csv format at the given location.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:returnValues /> </command:command> <!-- Cmdlet: Get-CacheClientStatistics --> <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> <maml:description> <maml:para>Gets statistics of the cache.</maml:para> </maml:description> <command:name>Get-CacheClientStatistics</command:name> <command:verb>Get</command:verb> <command:noun>CacheClientStatistics</command:noun> </command:details> <command:description> <maml:para>Get-CacheClientStatistics cmdlet displays the the value of client performance counters for a given cache for one or more client nodes. The list of counters that this cmdlet displays can be customized. </maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CacheClientStatistics</maml:name> <!-- Parameter: CacheName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Clients --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Clients</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: CounterNames --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>CounterNames</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DoNotShowDefaultCounters --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DoNotShowDefaultCounters</maml:name> <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> <!-- Parameter: Continuous --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Continuous</maml:name> <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> <!-- Parameter: Format --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Format</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: SampleInterval --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SampleInterval</maml:name> <command:parameterValue required="true">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaxSamples --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaxSamples</maml:name> <command:parameterValue required="true">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: CacheName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <maml:description> <maml:para>Specifies the name of the cache for which counters will be fetched.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Clients --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Clients</maml:name> <maml:description> <maml:para>Specifies one or more client IP Address(es) where the NCache service is running as well as client to specified cache is registered. The default is the local machine. Note: Comma separated client names are to be specified in case of multiple clients inside double quotes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: CounterNames --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>CounterNames</maml:name> <maml:description> <maml:para> Specifies one or more cache counter name(s) for which the values should be displayed. This option can be used to customize the list of counters to be displayed. Note: Comma separated counter names are to be specified in case of multiple counters inside double quotes. For a complete list of NCache counters, please visit http://www.alachisoft.com/resources/docs/ncache/admin-guide/cache-counters.html. </maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: DoNotShowDefaultCounters --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DoNotShowDefaultCounters</maml:name> <maml:description> <maml:para> Indicates that this cmdlet doesn't display the default counters. This should only be used when -CounterNames parameter is used.</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> <!-- Parameter: Format --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Format</maml:name> <maml:description> <maml:para> Specifies how the values of counters should be displayed. By default, its Tabular. CSV is recommended for output redirection to a file. CSV format can be converted to .blg which can be opened in Windows Performance Monitor.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Continuous --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Continuous</maml:name> <maml:description> <maml:para> Indicates that this cmdlet gets statistics continuously. By default, this cmdlet gets statistics only once. You can use the SampleInterval parameter to set the interval for continuous sampling.</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> <!-- Parameter: SampleInterval --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SampleInterval</maml:name> <maml:description> <maml:para>Specifies the time between samples in seconds.The default value is 3 seconds. Minimum value is 1.</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>3</dev:defaultValue> </command:parameter> <!-- Parameter: MaxSamples --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaxSamples</maml:name> <maml:description> <maml:para>Specifies the number of samples to get from each counter. The default is 1 sample. To get samples continuously (no maximum sample size), use the Continuous parameter. </maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-CacheClientStatistics -CacheName demoCache</dev:code> <dev:remarks> <maml:para> This command gets default counters for 'democache' from the local node.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Get-CacheClientStatistics -CacheName demoCache -Clients "20.200.21.19,20.200.21.20"</dev:code> <dev:remarks> <maml:para> This command gets default counters for 'democache' from the given two client nodes.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Get-CacheClientStatistics -CacheName demoCache -Clients "20.200.21.19,20.200.21.20" -CounterNames "Compression/sec"</dev:code> <dev:remarks> <maml:para> This command gets values of specified counter names along side the default counters for 'democache'.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Get-CacheClientStatistics -CacheName demoCache -Clients "20.200.21.19,20.200.21.20" -CounterNames "Compression/sec" -DoNotShowDefaultCounters</dev:code> <dev:remarks> <maml:para>This command gets values of specified counter names for 'democache'. It does not display the values of default counters.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Get-CacheClientStatistics -CacheName demoCache -Clients "20.200.21.19,20.200.21.20" -CounterNames "Compression/sec" -MaxSamples 50</dev:code> <dev:remarks> <maml:para>This command gets the 50 samples from defined counters for 'democache'.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Get-CacheClientStatistics -CacheName demoCache -Clients "20.200.21.19,20.200.21.20" -Continuous</dev:code> <dev:remarks> <maml:para>This command gets values of counters for 'democache' continuously after every 3 seconds.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 7 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Get-CacheClientStatistics -CacheName demoCache -Clients "20.200.21.19,20.200.21.20" -Continuous -SampleInterval 5</dev:code> <dev:remarks> <maml:para>This command gets values of counters for 'democache' continuously after every 5 seconds.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 8 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Get-CacheClientStatistics -CacheName demoCache -Continuous -SampleInterval 1 -Format CSV | Out-File -Encoding ASCII "C:\stats.csv" </dev:code> <dev:remarks> <maml:para>This command gets values of default counters for 'democache' continuously after every 1 seconds and saves the output in csv format at the given location.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:returnValues /> </command:command> <!-- Cmdlet: New-MemoryDump --> <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-MemoryDump</command:name> <maml:description> <maml:para>Start the process to take dump for cache/process id specified.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>MemoryDump</command:noun> </command:details> <command:description> <maml:para> New-MemoryDump enables the user to take memory dump of cache or NCache service. The cmdlet doesn't wait for memory dump to complete.</maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-MemoryDump</maml:name> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: CachName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ProcessId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProcessId</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WaitForCompletion --> <command:parameter required="false" globbing="false" pipelineInput="false (ByPropertyName)" position="named"> <maml:name>WaitForCompletion</maml:name> <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> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8250</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies a server name where the NCache service is running.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: CacheName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <maml:description> <maml:para>Specifies CacheName for which the dump is needs to be created on the server specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ProcessId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ProcessId</maml:name> <maml:description> <maml:para>Specifies the ProcessId for which the dump is needs to be created on the server specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: WaitForCompletion --> <command:parameter required="false" globbing="false" pipelineInput="false (ByPropertyName)" position="named"> <maml:name>WaitForCompletion</maml:name> <maml:description> <maml:para>Do not exit until the memory dump is captured.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on which NCache server is listening.</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>8250</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>New-MemoryDump -Server 20.200.21.11 -CacheName demoCache </dev:code> <dev:remarks> <maml:para>This command initiates dump generation on server 20.200.21.11 for CacheName demoCache</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-MemoryDump -Server 20.200.21.11 -ProcessId 1234 </dev:code> <dev:remarks> <maml:para>This command initiates dump generation on server 20.200.21.11 for Process id 1234</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-MemoryDump -Server 20.200.21.11 -ProcessId 1234 -WaitForCompletion </dev:code> <dev:remarks> <maml:para>This command initiates dump generation on server 20.200.21.11 for Process id 1234 and wait for the completion of dump generation.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: GetMemoryDumpList --> <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-MemoryDumpList</command:name> <maml:description> <maml:para>Gets the list of memory dumps taken and saved on the given server.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>MemoryDumpList</command:noun> </command:details> <command:description> <maml:para>Get-MemoryDumpList lists the memory dumps taken and saved on the given server</maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-MemoryDumpList</maml:name> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8250</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies a server name where the NCache service is running.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on which NCache server is listening.</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>8250</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-MemoryDumpList -Server 20.200.21.11 </dev:code> <dev:remarks> <maml:para>This command list down the dumps created on server 20.200.21.11.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet:Remove-MemoryDump --> <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>Remove-MemoryDump</command:name> <maml:description> <maml:para>Deletes the given memory dump file from the specified server.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>MemoryDump </command:noun> </command:details> <command:description> <maml:para>Remove-MemoryDump deletes the given memory dump file from the specified server.</maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-MemoryDump</maml:name> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: FileName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>FileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies a server name where the NCache service is running.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: FileName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Specifies the name of memory dump file that should be deleted.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on which NCache server is listening.</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>-1</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> Remove-MemoryDump -Server 20.200.21.11 -FileName dumpFile.dmp </dev:code> <dev:remarks> <maml:para>This command deletes the dump file on server 20.200.21.11 with specified name</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CacheLogsList --> <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-CacheLogsList</command:name> <maml:description> <maml:para>Get all the log-files in NCache logs-files directory or the log-file of a specific cache.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>CacheLogsList</command:noun> </command:details> <command:description> <maml:para>Get-CacheLogsList enables the user to get all the log-files in NCache logs-files directory or the log-file of a specific cache.</maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CacheLogsList</maml:name> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: CacheName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>CacheName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: CacheName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>CacheName</maml:name> <maml:description> <maml:para>Specifies the cache-name of which you want to get the log-file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the server from which you want to get the log-files.</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:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-CacheLogsList -Server 20.200.20.34 -Name demoCache</dev:code> <dev:remarks> <maml:para>This command get the log-files of demoCache from the specified server.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> </maml:introduction> <dev:code>Get-CacheLogsList -Server 20.200.20.34</dev:code> <dev:remarks> <maml:para>This command get all the log-files from the specified server.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CacheLogs --> <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-CacheLogs</command:name> <maml:description> <maml:para>Copy all the log-files or the specified log-files in the destination directory.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>CacheLogs</command:noun> </command:details> <command:description> <maml:para>Get-CacheLogs enables the user to copy all the log-files or the specified log-files in the destination directory.</maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CacheLogs</maml:name> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: FileNames --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>FileNames</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Destination</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: FileNames --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>FileNames</maml:name> <maml:description> <maml:para>Comma separated file-names which you want to copy from the server.Please mention complete file-names with extension to run the tool successfully.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the server for which you want to use this tool.</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: Destination --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Specifies the destination directory in which you want to copy the log-files.</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:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-CacheLogs -Server 20.200.20.34 -FileNames "myPartitionedCache_18-5-2020-10-45-38_20.200.20.34,ClusteredCache_18-5-2020-9-34-25_20.200.20.34" -Destination "C:\Users\administrator\Desktop\LogFiles"</dev:code> <dev:remarks> <maml:para>This command copies the specified files from the server to the destination 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>Get-CacheLogs -Server 20.200.20.34 -FileNames * -Destination "C:\Users\administrator\Desktop\LogFiles" </dev:code> <dev:remarks> <maml:para>This command copies all the files from the server to the destination directory.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Register-NCacheEvaluation --> <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>Register-NCacheEvaluation</command:name> <command:verb>Register</command:verb> <command:noun>NCacheEvaluation</command:noun> </command:details> <command:description> <maml:para>Register-NCacheEvaluation cmdlet registers the NCache installed on machine for FREE evaluation and/or extension. </maml:para> </command:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Register-NCacheEvaluation</maml:name> <!-- Parameter: Key --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Key</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>ExtKey</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Company --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Company</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Email --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Email</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FirstName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>FirstName</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LastName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>LastName</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8250</dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <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: Key --> <command:parameter required="false" globbing="false" pipelineInput="false (ByValue, ByPropertyName)" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para> Specifies the evaluation key received from Alachisoft.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ExtKey --> <command:parameter required="false" globbing="false" pipelineInput="false (ByValue, ByPropertyName)" position="named"> <maml:name>ExtKey</maml:name> <maml:description> <maml:para> Specifies the extension key received from Alachisoft.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: FirstName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>Specifies User's First name to be register .</maml:para> </maml:description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: LastName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>Specifies User's Last name to be register .</maml:para> </maml:description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Email --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Email</maml:name> <maml:description> <maml:para>Specifies User's Email to be register .</maml:para> </maml:description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Company --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Company</maml:name> <maml:description> <maml:para>Specifies User's Company Name to be register .</maml:para> </maml:description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies IP address of the local machine which is configured to be used by NCache service. This parameter should be given when the machine has more than two network cards. Only the IP address of local machine is accepted.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: NoLogo --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NoLogo</maml:name> <maml:description> <maml:para>Suppresses display of the logo banner.</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>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>The following command registers NCache for FREE evaluation. You can get FREE evaluation key by registering yourself on https://www.alachisoft.com/activate/RequestKey.php?Edition=NC-ENTO-50-4x&Version=5.0&Source=Register-NCache"</maml:paragraph> </maml:introduction> <dev:code>Register-NCacheEvaluation -Key xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -FirstName Paul -LastName Jones -Email paul.jones@alachisoft.com -Company alachisoft</dev:code> <dev:remarks> <maml:para>This command registers NCache for free Evaluation.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>The following command extends NCache evaluation period by providing a valid extension key."</maml:paragraph> </maml:introduction> <dev:code>Register-NCacheEvaluation -ExtKey XXXXXXXXXXXXXXXX </dev:code> <dev:remarks> <maml:para>This command extends evaluation of NCache on the machine.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>The following command registers NCache for FREE evaluation and then also extends NCache evaluation period incase of a valid extension key . You can get FREE evaluation key by registering yourself on https://www.alachisoft.com/activate/RequestKey.php?Edition=NC-ENTO-50-4x&Version=5.0&Source=Register-NCache"</maml:paragraph> </maml:introduction> <dev:code>Register-NCacheEvaluation -Key xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -FirstName Paul -LastName Jones -Email paul.jones@alachisoft.com -Company alachisoft -ExtKey XXXXXXXXXXXXXXXX</dev:code> <dev:remarks> <maml:para>This command registers NCache for free Evaluation and then also extends NCache evaluation period.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> </helpItems> |