> For the complete documentation index, see [llms.txt](https://docs.lithnet.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.lithnet.io/ams/help-and-support/advanced-help-topics/agent-command-line-legacy.md).

# Agent command line reference (legacy)

This document provides a reference for command line options for the Lithnet Access Manager Agent versions prior to 3.0.1500.

{% hint style="info" %}
This documentation applies to agent versions less than 3.0.1500. For agent versions 3.0.1500 and later, please refer to the [updated command line reference](/ams/help-and-support/advanced-help-topics/agent-command-line.md) which uses a new structured command format.
{% endhint %}

## Global Options

These options apply to all platforms:

| Option      | Description                            |
| ----------- | -------------------------------------- |
| `--help`    | Shows help information for the command |
| `--version` | Shows version information              |

## Interactive Setup

```
Lithnet.AccessManager.Agent --setup
```

Perform setup using interactive setup wizard. This command will:

1. Prompt for server address
2. Prompt for registration mode
3. Collect additional information based on the selected mode
4. Apply the configuration and restart the service

## Non-Interactive Setup

### Active Directory (Negotiate) Authentication

```
Lithnet.AccessManager.Agent --server <servername> --registration-mode iwa
```

Perform setup without user interaction, using Active Directory (Negotiate) authentication.

| Option                    | Description                                        |
| ------------------------- | -------------------------------------------------- |
| `--server <servername>`   | Set the hostname of the AMS server                 |
| `--registration-mode iwa` | Use Negotiate authentication to register the agent |

### Microsoft Entra Authentication (Windows Only)

```
Lithnet.AccessManager.Agent --server <servername> --registration-mode entra
```

Perform setup without user interaction, using Microsoft Entra as the authentication provider.

| Option                      | Description                                              |
| --------------------------- | -------------------------------------------------------- |
| `--server <servername>`     | Set the hostname of the AMS server                       |
| `--registration-mode entra` | Use Microsoft Entra authentication to register the agent |

> **Note:** The `entra` registration mode is only available on Windows platforms.

### Registration Key Authentication

```
Lithnet.AccessManager.Agent --server <servername> --registration-mode key --registration-key <key>
```

Perform setup without user interaction, using a registration key for authentication.

| Option                     | Description                        |
| -------------------------- | ---------------------------------- |
| `--server <servername>`    | Set the hostname of the AMS server |
| `--registration-mode key`  | Use a key to register the agent    |
| `--registration-key <key>` | Set the registration key           |

## Agent State Control

Control the agent state:

```
Lithnet.AccessManager.Agent --disable
Lithnet.AccessManager.Agent --enable
```

| Option      | Description       |
| ----------- | ----------------- |
| `--disable` | Disable the agent |
| `--enable`  | Enable the agent  |

## Agent Reset

Reset the agent. This deletes all settings and authentication certificates:

```
Lithnet.AccessManager.Agent --reset
Lithnet.AccessManager.Agent --reset --force
Lithnet.AccessManager.Agent --reset --keep-cert
```

| Option                | Description                                            |
| --------------------- | ------------------------------------------------------ |
| `--reset`             | Reset the agent                                        |
| `--reset --force`     | Reset the agent without prompting for confirmation     |
| `--reset --keep-cert` | Reset the agent but keeps the agent's auth certificate |

## Administration Requirements

Many commands require administrator rights:

* Windows: Run Command Prompt or PowerShell as Administrator
* macOS/Linux: Use sudo or run as root

## Examples of Common Workflows

### Initial Setup with Active Directory

```
Lithnet.AccessManager.Agent --server ams.example.com --registration-mode iwa
```

### Initial Setup with Registration Key

```
Lithnet.AccessManager.Agent --server ams.example.com --registration-mode key --registration-key YOUR-KEY-HERE
```

### Disable Agent

```
Lithnet.AccessManager.Agent --disable
```

### Reset Agent

```
Lithnet.AccessManager.Agent --reset --force
```

## Troubleshooting

If you encounter issues:

1. Ensure you're running with administrator rights
2. Check the agent logs
3. For agent versions 3.0.1500 and later, refer to the [updated command line reference](/ams/help-and-support/advanced-help-topics/agent-command-line.md)
4. Try resetting the agent with `--reset --force`

For additional help, consult the full Lithnet Access Manager documentation.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.lithnet.io/ams/help-and-support/advanced-help-topics/agent-command-line-legacy.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.