Basic Core Help Example

This sample invokes and displays the results of the “core help” remote command via the ePO DXL service. The “core help” command lists the remote commands that are exposed by a particular ePO server.

The majority of the sample code is shown below:

Sample Code

# The ePO unique identifier
EPO_UNIQUE_ID = None

# Create the client
with DxlClient(config) as client:

    # Connect to the fabric
    client.connect()

    # Create the ePO client
    epo_client = EpoClient(client, EPO_UNIQUE_ID)

    # Display the help
    print(epo_client.help())

Once a connection is established to the DXL fabric, a EpoClient instance is created which will be used to invoke remote commands on the ePO server. The unique identifier of the ePO server to invoke remote commands on is specified as an argument to the client constructor. In this particular case, a value of None is specified which triggers the client to automatically determine the ePO server's unique identifier. This will not work if multiple ePO servers are connected to the fabric (an exception will be raised).

Next, the results of invoking the EpoClient.help() method are displayed to the screen.

Output

The output should appear similar to the following:

ComputerMgmt.createAgentDeploymentUrlCmd deployPath groupId urlName
agentVersionNumber agentHotFix [edit] [ahId] [fallBackAhId] - Create Agent
Deployment URL Command
ComputerMgmt.createCustomInstallPackageCmd deployPath [ahId] [fallBackAhId] -
Create Custom Install Package Command
ComputerMgmt.createDefaultAgentDeploymentUrlCmd tenantId - Create Default
Non-Editable Agent Deployment URL Command
ComputerMgmt.createTagGroup parentTagGroupId newTagGroupName - Create a new
subgroup under an existing tag group.
ComputerMgmt.deleteTag tagIds [forceDelete] - Delete one or more tags.

...

Each remote command exposed by the particular ePO server is listed along with its associated parameters.