8.2 KiB
title, description, ms.service, ms.subservice, ms.topic, manager, ms.author, author, ms.reviewer, ms.collection, appliesto, ms.date
| title | description | ms.service | ms.subservice | ms.topic | manager | ms.author | author | ms.reviewer | ms.collection | appliesto | ms.date | |||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| MCC for Enterprise manage cache nodes using CLI | Microsoft Connected Cache for Enterprise. Learn about managing cache nodes using CLI | windows-client | itpro-updates | how-to | aaroncz | nidos | doshnid | mstewart | tier3 |
|
06/03/2024 |
Manage cache nodes using CLI
This article outlines how to create, configure and provision your Microsoft Connected Cache for Enterprise cache nodes using Azure CLI.
Prerequisites:
- Install Azure CLI: How to install the Azure CLI
- Install MCC extension: Install the MCC extension.
1. Create a Resource group
The first step is to create a resource group if you don't already have one. An Azure resource group is a logical container into which Azure resources are deployed and managed.
To create a resource group, use az group create.
az group create --name myrg --location westus
Once the resource group is created, you will need to create a Microsoft Connected Cache for Enterprise resource.
2. Create a MCC resource
A MCC resource is a resource under which cache nodes can be created.
To create a mcc resource, use az mcc ent resource create
az mcc ent resource create --mcc-resource-name mymccresource --resource-group myrg
Important
In the output, look for operationStatus. operationStatus = Succeeded indicates that our services have successfully started creating MCC resource.
The next step is to create a cache node under this resource.
3. Create a cache node
To create a cache node, use az mcc ent node create
az mcc ent node create --cache-node-name mycachenode --mcc-resource-name mymccresource --resource-group myrg --host-os linux
Important
In the output, look for operationStatus. operationStatus = Succeeded indicates that our services have successfully started creating cache node.
4. Confirm cache node creation
Before you can start configuring your cache node, you need to confirm that cache node creation has been successful. To confirm cache node creation, use az mcc ent node show
az mcc ent node show --cache-node-name mycachenode --mcc-resource-name mymccresource --resource-group myrg
Important
In the output look for cacheNodeState. If cacheNodeState = Not Configured, you can continue with cache node configuration. If cacheNodeState = Registration in Progress, then the cache node is still in process of being created. Please wait for a minute or two more and run the command again.
Once the cache node has been created successfully, you can now configure the cache node.
5. Configure cache node
To configure your cache node, use az mcc ent node update
The below example configures a Linux cache node with proxy enabled:
az mcc ent node update --cache-node-name <mycachenode> --mcc-resource-name <mymccresource> --resource-group <myrg>
--cache-drive "[{physical-path:</physical/path>,size-in-gb:<size of cache drive>},{</physical/path>,size-in-gb:<size of cache drive>}...]"> --proxy <enabled> --proxy-host <"proxy host name"> --proxy-port <proxy port> --auto-update-day <day of week> --auto-update-time <time of day> --auto-update-week <week of month> --auto-update-ring <update ring>
Note
For a cache node that is to be deployed on Windows host OS, the physical path of the cache drive must be /var/mcc.
Note
Proxy info changes, required to provision cache node.
Important
In the output, look for operationStatus. operationStatus = Succeeded indicates that our services have successfully updated the cache node.
Important
Please save values for physicalPath, sizeInGb, proxyPort, proxyHostName as these values will be needed to create the provisioning script.
6. Get provisioning details for the cache node
Now that you have configured the cache node, the next step is to provision the cache node on the server. To provision the cache node, you will need to create a provisioning script with relevant information. To get the relevant information for provisioning script, use az mcc ent node get-provisioning-details
az mcc ent node get-provisioning-details --cache-node-name mycachenode --mcc-resource-name mymccresource --resource-group myrg
In the output, please save the values for cacheNodeId, customerKey, mccResourceId, registrationKey. These values are needed to create the provisioning script.
7. Provisioning cache node
Provisioning cache node on Linux host OS:
Before you provision your cache node on Linux machine, please make sure you have completed the requisites listed here: Host machine requirements
Use the link below to download and unzip the provisioning package on the server and run the below script to provision your cache node.
Download MCC package for Linux host OS
Important
Note: before you execute the script, please make sure you change access permissions by running the command below
sudo chmod +x provisionmcc.sh
Note
Please replace the sample values in the script below with the values that you saved in the step 5 and 6.
Important
'shoulduseproxy' parameter is required, whether or not your network uses proxy to access internet.
Provisioning script:
powershell-interactive sudo ./provisionmcc.sh customerid="enter mccResourceId here" cachenodeid=" enter cacheNodeId here " customerkey=" enter customerKey here " registrationkey="enter registrationKey here" drivepathandsizeingb="enter physicalPath value,enter sizeInGb value here" shoulduseproxy="true" proxyurl=http://enter proxy hostname:enter port
Provisioning cache node on Windows host OS:
Before you provision your cache node on Windows, make sure you have completed the requisites listed here: Host machine requirements
Please download and unzip the provisioning package on the server and run the below script to provision your cache node. Note: Please replace the sample values with the values that you saved in the above steps.
Important
'shoulduseproxy' parameter is required, whether or not your network uses proxy to access internet.
Download MCC package for Windows host OS
If you are using a gmsa account:
./provisionmcconwsl.ps1 -installationFolder c:\mccwsl01 -customerid enter mccResourceId here -cachenodeid enter cacheNodeId here -customerkey enter customerKey here -registrationkey enter registration key -cacheDrives "/var/mcc,enter drive size" -shouldUseProxy $true -proxyurl " http://enter proxy host name:enter port" -mccRunTimeAccount $User
If you are using local user account or domain user account:
./provisionmcconwsl.ps1 -installationFolder c:\mccwsl01 -customerid enter mccResourceId here -cachenodeid enter cacheNodeId here -customerkey enter customerKey here -registrationkey enter registration key -cacheDrives "/var/mcc,enter drive size" -shouldUseProxy $true -proxyurl " http://enter proxy host name:enter port" -mccRunTimeAccount $User -mccLocalAccountCredential $myLocalAccountCredential
Next step
To verify cache node functionality, visit, Verify cache node functionality
Sample script:
Below is a pseudo code that shows how the above can be scripted for bulk creation and configuration of cache node.