Referencing systems and branches

The commands available through the Drive Encryption Web API and ePO - On-prem Web API commands, commonly need to reference a system or a branch within the ePO - On-prem System Tree.

The following terms are used throughout this guide:

Computer ID: This term refers to a number (also known as a leafNodeId) that identifies the system in the System Tree. You can identify this number by using the EPOComputerProperties.ParentID attribute. This attribute is part of the system.find command output.
Branch ID: This term refers to a number that identifies a branch (also known as groupId) within the ePO - On-prem System Tree. You can identify this number by:
- Locating a system through the system.find command, and inspecting the EPOBranchNode.AutoID attribute
- Locating a System Tree group through the system.findGroup command, and inspecting the groupId attribute
systemNode: This is a Drive Encryption Web API command parameter that controls the meaning of nodeId. Its possible values are ‘True’ or ‘False’.
nodeId: This is a Drive Encryption Web API command parameter. The meaning of nodeId changes depending on the value of the systemNode parameter:
- If systemNode = ‘True’: nodeId means Computer Id / leafNodeId
- If systemNode = ‘False’: nodeId means Branch Id / groupId

The following examples show how the standard ePO - On-prem Web API commands are used to obtain the Computer ID or Branch ID:

Search by system

To find information about system TEST123, run this remote command: https://myeposerver:8443/remote/system.find?searchText=TEST123&:output=xml?>.

The output contains the following (among other output):

OK:

<?xml version="1.0" encoding="UTF-8"?>

<result>

<list>

<row>

<EPOComputerProperties.ParentID>272</EPOComputerProperties.ParentID>

…

<EPOBranchNode.AutoID>58</EPOBranchNode.AutoID>

</row>

</list>

</result>

Locating System Tree branch / group ID

To find the System Tree group identifier, run this remote command: https://myeposerver:8443/remote/system.findGroups?searchText=?>.

The output contains a list of all System Tree groups, with their groupId:

OK:

groupId: 2

groupPath: My Organization

groupId: 3

groupPath: My Organization\Lost&Found