core/CloudTools.NetCore.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>CloudTools.NetCore</name> </assembly> <members> <member name="T:CloudTools.ToolBase.Install.InstallAzurePowerShell"> <summary> Installs azure power shell cmdlets on the machine </summary> <example> ```Example 1:Install-NCAzurePSPreReqs ``` Installs Azure power shell cmdlets on the machine locally </example> </member> <member name="T:CloudTools.ToolBase.Stop.StopNcAzCache"> <summary> Stops one or more NCache caches in Azure. </summary> <para type="synopsis">Stops one or more NCache caches in Azure.</para> <para type="description"> The Stop-NcAzCache cmdlet stops one or more caches in Azure. You can stop gracefully, for maintenance, or forcefully. </para> <example> <code>Stop-NcAzCache -EnvironmentName "ProdRG" -Name "demoCache" -IsGracefulStop</code> <para>Stops demoCache gracefully in ProdRG.</para> </example> </member> <member name="T:CloudTools.ToolsParametersBase.AddNCAzClientParameters"> <summary> Adds client node in the cache </summary> <example> ``` Example 1: Add-NCAzClient -EnvironmentName prod-env -CacheName demoCache -Server 20.200.21.11 -ClientNode 20.200.21.12 ``` Adds client node to the demoCache which exists on server 20.200.20.11 inside the environment </example> <example> ``` Example 2: Add-NCAzClient -EnvironmentName prod-env -Server 20.200.21.11 -ClientNode 20.200.21.12 ``` Adds client node to the caches inside the environment </example> <example> ``` Example 3: Add-NCAzClient -EnvironmentName prod-env -CacheName demoCache -Server 20.200.21.11 -ClientNode 20.200.21.12 -UpdateServerConfig -Port 8250 ``` Adds client node to the named cache inside the environment while specifying port-number and updating server config </example> </member> <member name="T:CloudTools.ToolsParametersBase.AddServerParameters"> <summary> Adds specified number of servers in an environment </summary> <example> ``` Example 1: Add-NCAzServer -EnvironmentName prod-env -VmCount 3 -Password 4Islamabad``` Adds 3 vms to the environment and also adds them in all the existing caches </example> </member> <member name="T:CloudTools.ToolsParametersBase.CreateEnvironmentParameters"> <summary> Creates a new Environment in the region specified with number of vms specified </summary> <example> ``` Example 1: New-NCAzEnvironment -ServerPlan ENT-4/2 -EnvironmentName Prod-Env -Location CENTRALUS -Cidr 10.0.0.0/24 -VmCount 2 -Version 5.3.6 -CompanyName xyz -FirstName bilal -LastName ahmad -Email setup@diya-tech.com -Password 4Islamabad -EvaluationKey EBe398Y2MHeQ9/a2sJBQQYD3UyLDw6OwgkJz4tdScwPDt1ODUzaGNhfG5iclFQVl5QWERWT1BUAgBOHRUcGEAYER -OS Windows -Zone ZONE1 -UserName ncadmin -Edition Enterprise -Publisher MicrosoftWindowsServer -Offer WindowsServer -Sku 2025-Datacenter -ImageVersion latest -WhiteListIps "78.100.65.182" -AllowedOperationsOnPublicIp Management ``` Creates an environment with 2 vms using Windows 2025 image and installs ncache version 5.3.6 on them creates a public ip with whitelisted ip </example> <example> ``` Example 2: New-NCAzEnvironment -ServerPlan ENT-4/2 -EnvironmentName Prod-Env -Location CENTRALUS -Cidr 10.0.0.0/24 -VmCount 2 -Version 5.3.6 -CompanyName xyz -FirstName bilal -LastName ahmad -Email setup@diya-tech.com -Password 4Islamabad -EvaluationKey EBe398Y2MHeQ9/a2sJBQQYD3UyLDw6OwgkJz4tdScwPDt1ODUzaGNhfG5iclFQVl5QWERWT1BUAgBOHRUcGEAYER -OS Windows -Zone ZONE1 -UserName ncadmin -Edition Enterprise -Publisher MicrosoftWindowsServer -Offer WindowsServer -Sku 2025-Datacenter -ImageVersion latest -DoNotCreatePublicIp ``` Creates an environment with 2 vms using Windows 2025 image and installs ncache version 5.3.6 on them but doesn't creates a publicip </example> </member> <member name="T:CloudTools.ToolsParametersBase.GetNcAzCachesParameters"> <summary> ## SYNOPSIS Lists the registered caches in Azure environment. ## DESCRIPTION Get-NCAzCaches cmdlet enables the user to list the total caches registered on the server in an Azure Environment and there status. ##Examples ### Example 1 ```Get-NCAzCaches -EnvironmentName test``` This command displays all caches registered in Azure Environment. ### Example 2 ```Get-NCAzCaches -EnvironmentName test -Detail -Server 20.200.21.11``` This command displays all caches currently registered on the provided server with detailed information. ### Example 3 ```Get-Caches -EnvironmentName test -Detail``` This command displays all caches currently registered on the azure environment with detailed information. </summary> </member> <member name="T:CloudTools.ToolsParametersBase.GetNCAzClusterHealthParameters"> <summary> ## SYNOPSIS Gets cluster state on cache in Azure environment. ## DESCRIPTION Get-NCAzClusterhealth cmdlet cmdlet displays all the nodes registered on specified cache. It displays the status, number of connected clients and connection information of the cache. ##Examples ### Example 1 ```Get-NCAzClusterhealth -EnvironmentName test -CacheName demoCache``` This command gets the nodes, status, connection information and connected clients count for 'demoCache'. ### Example 2 ```Get-NCAzClusterhealth -EnvironmentName test -CacheName demoCache -Server 20.200.21.11``` This command gets the nodes, status, connection information and connected clients count for 'demoCache' on the Server '20.200.21.11'. </summary> </member> <member name="T:CloudTools.ToolsParametersBase.GetNcAzConnectedClientsParameters"> <summary> ## SYNOPSIS Get connectedclients that connected with server nodes in Azure environment. ## DESCRIPTION Get-NcAzConnectedClients cmdlet list all registered clients on server. It displays the client machine IP, when machine is activated with server-activated license. ##Examples ### Example 1 ```Get-NcAzConnectedClients -EnvironmentName test``` This command gets all connected client registered on Azure Environment. ### Example 2 ```Get-NcAzConnectedClients -EnvironmentName test -Server 20.200.21.11``` This command gets all connected client registered on server 20.200.21.11. ### Example 3 ```Get-NcAzConnectedClients -EnvironmentName test -Server 20.200.21.11 -Port 8250``` This command uses port and gets all connected client registered on server 20.200.21.11. </summary> </member> <member name="T:CloudTools.ToolsParametersBase.GetNCAzServerStatisticsParameters"> <summary> ## SYNOPSIS Gets statistics of the cache in Azure environment. ## DESCRIPTION Get-NCAzServerStatistics 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. ##Examples ### Example 1 ```Get-NCAzServerStatistics -EnvironmentName test -CacheName demoCache``` This command gets default counters for 'democache' from all servers in 'test' Environment. ### Example 2 ```Get-NCAzServerStatistics -EnvironmentName test -CacheName demoCache -Servers "20.200.21.19,20.200.21.20"``` This command gets default counters for 'democache' from the given two server nodes. ### Example 3 ```Get-NCAzServerStatistics -EnvironmentName test -CacheName demoCache -Servers "20.200.21.19,20.200.21.20" -CounterNames "Hits/sec, Misses/sec"``` This command gets values of specified counter names along side the default counters for 'democache'. </summary> </member> <member name="T:CloudTools.ToolsParametersBase.InstallNCAzClientParameters"> <summary> Installs NCache client on the specified vm </summary> <example> ``` Example 1: Install-NCAzClient -VmName NC-Server-1 -Email setup@diya-tech.com -ResourceGroupName prod-env -Company alachisoft -Key xxxxx-xxxx-xxxx-xxx -FirstName bilal -LastName ahmad -InstallDir "C:\\Program Files\\NCache" ``` Installs Ncache client on the specified vm with provided credentials </example> </member> <member name="T:CloudTools.ToolsParametersBase.ListAllEnvironmentsParameters"> <summary> ## SYNOPSIS Gets list of ncache environments from azure subscription. ## DESCRIPTION Get-NzAzEnvironment cmdlet displays the list of all ncache environments (resource groups) present in azure subscription. ##Examples ### Example 1 ```Get-NzAzEnvironment``` This command return all the ncache envrionments (resource groups) present at current subscription. </summary> </member> <member name="T:CloudTools.ToolsParametersBase.ListAllVmsParameters"> <summary> ## SYNOPSIS Gets the list of all virtual machines in the specified NCache Azure environment. ## DESCRIPTION The `Get-NCAzServer` cmdlet displays all VMs that are part of the given NCache Azure environment. This helps administrators quickly verify which VMs are currently provisioned inside a particular environment. ## EXAMPLES ### Example 1 ```Get-NCAzServer -EnvironmentName "TestEnv"``` Returns all VMs with NCache server available under the `NC-TestEnv` Resource Group. </summary> </member> <member name="T:CloudTools.ToolsParametersBase.NewNcAzCacheParameters"> <summary> ## SYNOPSIS Creates a new cache in Azure environment. ## DESCRIPTION New-NCAzCache cmdlet enables the user to create a new cache cluster on the azure ncache enivronment. ##Examples ### Example 1 ```New-NCAzCache -EnvironmentName test -Name demoCache -Size 1024 -Topology PartitionReplica``` This command creates cache cluster named demoCache on azure environment each node having size 1024 MB and topology PartitionReplica. ### Example 2 ```New-NCAzCache -EnvironmentName test -Name demoCache -Size 1024 -Topology replicated -ClusterPort 8701``` This command creates a new Distributed Cache named demoCache on azure environment having size 1024 MB of each node and topology replicated and occupying the port 8701 for simple case. </summary> </member> <member name="T:CloudTools.ToolsParametersBase.NewNCAzClientCacheParameters"> <summary> ## SYNOPSIS Creates client cache on Client Node ## DESCRIPTION New-NCAzClientCache cmdlet enables the user to create a new client cache in Azure Environment. ##Examples ### Example 1 ```New-NCAzClientCache -EnvironmentName test -CacheName demoCache -ClientCacheName demoClientCache -Server 20.200.21.11 -Size 1024 -ClientNode 20.200.21.12``` This command creates regular client cache named demoClientCache on client node 20.200.21.12 for an already registered clustered cache on server 20.200.21.11 having size 1024 MB for simple case.. ### Example 2 ```New-NCAzClientCache -EnvironmentName test -CacheName demoCache -ClientCacheName demoClientCache -Type FullData -Server 20.200.21.11 -Size 1024 -ClientNode 20.200.21.12``` This command creates full-data client cache named demoClientCache on client node 20.200.21.12 for an already registered clustered cache on server 20.200.21.11 having size 1024 MB for simple case. ### Example 3 ```New-NCAzClientCache -EnvironmentName test -CacheName demoCache -ClientCacheName demoClientCache -Type FullData -Server 20.200.21.11 -Size 1024 -ClientNode 20.200.21.12 -Optimistic -FailQueryOnPartialDataset -DisableL2FallbackOnMiss``` This command creates full-data client cache named demoClientCache on client node 20.200.21.12 for an already registered clustered store on server 20.200.21.11 having size 1024 MB and optimistic Client Cache synchronization Mode and allowing SQL queries to run on client cache(Full-Data) and throw an exception when querying a partially loaded dataset in the client cache for partially loaded data in client cache(Full-Data) case. Also disable L2 fallback on data miss in client cache. </summary> </member> <member name="T:CloudTools.ToolsParametersBase.RemoveNCAzCacheParameters"> <summary> ## SYNOPSIS Removes the registered cache from azure environment. ## DESCRIPTION Remove-NCAzCache cmdlet enables the user to remove an already registered cache. ##Examples ### Example 1 ```Remove-NCAzCache -EnvironmentName test -Name demoCache``` This command removes the demoCache from azure environment. ### Example 2 ```Remove-NCAzCache -EnvironmentName test -Name demoCache -Port 8250``` This command uses port also and removes the demoCache from azure environment. </summary> </member> <member name="T:CloudTools.ToolsParametersBase.RemoveNCAzClientCacheParameters"> <summary> ## SYNOPSIS Removes client cache from client node. ## DESCRIPTION Remove-NCAzClientCache cmdlet enables the user remove client cache from client node. ##Examples ### Example 1 ```Remove-NCAzClientCache -EnvironmentName test -CacheName demoCache -ClientCacheName demoClientCache -ClientNode 20.200.21.11``` This command removes client cache named demoClientCache from client node 20.200.21.11. ### Example 2 ```Remove-NCAzClientCache -EnvironmentName test -CacheName demoCache -ClientCacheName demoClientCache -Server 20.200.21.11 -ClientNode 20.200.21.12``` This command removes client cache named demoClientCache on client node 20.200.21.12 for an already registered clustered cache on server 20.200.21.11. ### Example 3 ```Remove-NCAzClientCache -EnvironmentName test -CacheName demoCache -ClientCacheName demoClientCache -Server 20.200.21.11 -ClientNode 20.200.21.12 -Port 8250``` This command uses specified port to remove client cache named demoClientCache on client node 20.200.21.12 for an already registered clustered cache on server 20.200.21.11. </summary> </member> <member name="T:CloudTools.ToolsParametersBase.RemoveNCAzClientParameters"> <summary> Removes client node from the cache </summary> <example> ``` Example 1: Remove-NCAzClient -EnvironmentName prod-env -CacheName demoCache -Server 20.200.21.11 -ClientNode 20.200.21.12 ``` Removes client node from the demoCache which exists on server 20.200.20.11 inside the environment </example> <example> ``` Example 2: Remove-NCAzClient -EnvironmentName prod-env -Server 20.200.21.11 -ClientNode 20.200.21.12 ``` Removes client node from all the caches inside the environment </example> <example> ``` Example 3: Remove-NCAzClient -EnvironmentName prod-env -CacheName demoCache -Server 20.200.21.11 -ClientNode 20.200.21.12 -UpdateServerConfig -Port 8250 ``` Removes client node from the named cache inside the environment while specifying port-number and updating server config </example> </member> <member name="T:CloudTools.ToolsParametersBase.RemoveResourceGroupParameters"> <summary> Removes the specified environment </summary> <example> Example 1: Remove-NCAzEnvironment -EnvironmentName prod-env Removes the specified Environment </example> </member> <member name="T:CloudTools.ToolsParametersBase.RemoveVirtualMachinesParameters"> <summary> Removes specified vms from environment </summary> <example> Example 1: Remove-NCAzServer -EnvironmentName prod-env -VirtualMachines "NC-Server-1,NC-Server-2" Removes specified vms from the environment and also from the caches </example> </member> <member name="T:CloudTools.ToolsParametersBase.StartNcAzCacheParameters"> <summary> ## SYNOPSIS Starts the registered cache. ## DESCRIPTION Start-NCAzCache cmdlet starts the registered cache on azure environment. ##Examples ### Example 1 ```Start-NCAzCache -EnvironmentName test -CacheName demoCache``` This command starts cache named demoCache on azure 'test' Environment. ### Example 2 ```Start-NCAzCache -EnvironmentName test -Name demoCache -Server 20.200.21.11 -Port 8250``` This command uses port and starts cache named demoCache existing on server 20.200.21.11. ### Example 3 ```Start-NCAzCache -EnvironmentName test -Name demoCache -Server "20.200.21.11,20.200.21.12"``` This command starts cache named demoCache existing on servers 20.200.21.11 and 20.200.21.12. </summary> </member> <member name="T:CloudTools.ToolsParametersBase.StopNcAzCacheParameters"> <summary> ## SYNOPSIS Stops the registered cache in Azure environment. ## DESCRIPTION Stop-NCAzCache cmdlet enables users to stop a cache in Azure Environment. ##Examples ### Example 1 ```Stop-NCAzCache -EnvironmentName test -Name demoCache``` This command stops demoCache in 'test' Environment. ### Example 2 ```Stop-NCAzCache -EnvironmentName test -Name demoCache -Server 20.200.21.11 -IsGracefulStop``` This command stops cache demoCache gracefully existing on server 20.200.21.11. ### Example 3 ```Stop-NCAzCache -EnvironmentName test -Name demoCache -Server 20.200.21.11 -IsStopForMaintenance -Timeout 30``` This command stops cache for maintenance demoCache existing on server 20.200.21.11 for 30 minutes time period. </summary> </member> <member name="T:CloudTools.ToolsParametersBase.TestNcAzStressParameters"> <summary> ## SYNOPSIS Starts stress test tool on an NCache cache in Azure environment. ## DESCRIPTION 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. ##Examples ### Example 1 ```Test-NcAzStress -EnvironmentName test -CacheName demoCache``` This command executes stresstesttool on demoCache.This command reads deployment details specified in client.ncconf ### Example 2 ```Test-NcAzStress -EnvironmentName test -CacheName demoCache -DataSize 2048``` This command executes stresstesttool on demoCache and will add items of size 2kb. This command reads deployment details specified in client.ncconf ### Example 3 ```Test-NcAzStress -EnvironmentName test -CacheName demoCache -DataSize 2048 -Server "20.200.20.11,20.200.20.10"``` This command executes stresstesttool on demoCache and will add items of size 2kb. This command ignores deployment details specified in client.ncconf </summary> </member> </members> </doc> |