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

// Create the client
var client = new dxl.Client(config)

// The ePO unique identifier
var EPO_UNIQUE_ID = null

// Connect to the fabric, supplying a callback function which is invoked
// when the connection has been established
client.connect(function () {
  // Create the ePO client
  var epoClient = new EpoClient(client, EPO_UNIQUE_ID)

  // Run the help command
  epoClient.help(function (helpError, helpText) {
    // Destroy the client - frees up resources so that the application
    // stops running
    client.destroy()
    if (helpError) {
      console.log('Error getting help: ' + helpError.message)
    } else {
      // Display the help
      console.log(helpText)
    }
  })
})

Once a connection is established to the DXL fabric, the callback function supplied to the DXL client instance's connect() method will be invoked. From within the callback function, an EpoClient instance is created. The EpoClient instance 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 parameter to the client constructor. In this particular case, a value of null is specified, which triggers the client to automatically determine the ePO server's unique identifier.

Next, the EpoClient instance's help() method is called to invoke the help remote command on the ePO server. On successful execution of the ePO remote command, the helpText parameter provided to the callback function contains the command results. If the help command fails due to zero or multiple ePO servers being connected to the fabric, an error with failure details will be provided to the helpError parameter.

Output

The output should appear similar to the following:

ComputerMgmt.createAgentDeploymentUrlCmd deployPath groupId [edit] [ahId]
[fallBackAhId] [urlName] [agentVersionNumber] [agentHotFix] - 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.
ComputerMgmt.deleteTagGroup tagGroupIds [deleteTags] - Delete one or more Tag
Groups.
ComputerMgmt.listAllTagGroups - List All Tag Groups in Tag Group Tree
ComputerMgmt.moveTagsToTagGroup tagIds tagGroupId - Move tags to an existing tag
group.
...

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