Install an ADM agent as a microservice on a Kubernetes cluster

Last published : Sep 30, 2026
Deploying a NetScaler agent as a microservice is useful for managing your NetScaler CPX. The procedures available in this document are applicable only if the NetScaler ADM and Kubernetes cluster are configured on a different network. In this scenario, you can configure an ADM agent as a microservice, where the Kubernetes cluster is hosted.
Note
You can also configure an on-prem agent and register the agent on the network, where the Kubernetes cluster is hosted.
Related information
Configure on-prem agents for multisite deployment

Get started

  1. In NetScaler® ADM, navigate to Infrastructure > Instances > Agents.
  2. From the Select Action list, select the Download Agent Microservice option.
  3. In the Download Agent Microservice page, specify the following parameters:
    1. Application ID – A string id to define the service for the agent in the Kubernetes cluster and distinguish this agent from other agents in the same cluster.
    2. Password – Specify a password for CPX to use this password to onboard CPX to ADM through the agent.
    3. Confirm Password – Specify the same password for confirmation.
      Note
      You must not use the default password (nsroot).
    4. Click Download Yaml File.

Install NetScaler agent in Kubernetes cluster

In the Kubernetes main node:
  1. Save the downloaded YAML file
  2. Run the following command:
    kubectl create -f <yaml file>
    For example, kubectl create -f testing.yaml
    The agent is successfully created.
    Agent
In NetScaler ADM, navigate to Infrastructure > Instances > Agents to see the agent status.
After you configure the agent, you can add the NetScaler CPX instances and view analytics in service graph. For more information, see: