Windows Cloud Agent CLI reference
The Windows Cloud Agent supports a CLI as a troubleshooting tool and method of enrolling Windows machines in case enrollment with the installer fails.
To run the commands, open a command prompt with Administrator privileges and navigate to the Windows Cloud Agent installation directory: cd C:\Program Files\CyberArk\EndpointAgent\
.
Refer to the following sections for more information about each command.
Enrollment commands
cenroll
Usage: cenroll [-fhVv] [-c <code>] [-d value] [-e <username>] [-l <role1>[,<role2>...,<roleN>]] [-p <proxy URL>] [-t <url>] [-z <true/false>]
Parameter |
Description |
---|---|
-c, --code=<code> | Enrollment code to use to enroll this computer in CyberArk Identity. |
-e, --assignee=<username> | The user who this computer will be assigned to. Only one user can be assigned at a time. |
-h, --help | Print help information. This parameter is not available in the Windows Cloud Agent installer; only the command prompt. |
-l, --agentauth=<role1>[,<role2>...,<roleN>] | The roles allowed to authenticate and log on to this machine. |
-p, --http-proxy=<proxy URL> | HTTP proxy used while connecting to CyberArk Identity. You can also enter the hostname of the server hosting the CyberArk Identity Connector, which can function as a proxy to CyberArk Identity in the case of a server with no open inbound ports. |
-t, --tenant=<url> | Customer-specific URL. |
-v, --version | Print version information and exit. This parameter is not available in the Windows Cloud Agent installer; only the command prompt. |
Verify results in the Identity Administration portal at Endpoints > <enrolled Windows machine> > Permissions:
Verify results in the Identity Administration portal at Endpoints > <enrolled Windows machine> > Permissions:
Unenrollment commands
cunenroll
Usage: cunenroll [-fhmVv]
Parameter |
Description |
---|---|
-h, --help | Prints help output. |
-m, --machine |
Uses machine credentials to unenroll. This parameter is required. |
-v, --version | Prints version information. |