Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AgentService

Agent Service provides method based API related to spawn sequence manager and sequence component, also to kill spawned components

interface

Hierarchy

  • AgentService

Index

Methods

getAgentStatus

  • gives status of TMT ecosystem components(agents, sequence components and sequencers). It provides information about which agents are up and running, sequence components running on those agents and sequencer script loaded on sequence component.

    Returns Promise<AgentStatusResponse>

    AgentStatusResponse as Promise.

killComponent

spawnSequenceComponent

  • spawnSequenceComponent(agentPrefix: Prefix, componentName: string, version?: string): Promise<SpawnResponse>
  • This API is used to spawn sequence component on agent machine and returns a promise of SpawnResponse.

    Parameters

    • agentPrefix: Prefix

      The prefix of the agent machine where sequence component needs to be spawned.

    • componentName: string

      The name of the component.

    • Optional version: string

      The OCS App version. default value is '3.0.0-M1'

    Returns Promise<SpawnResponse>

    SpawnResponse as Promise

spawnSequenceManager

  • spawnSequenceManager(agentPrefix: Prefix, obsModeConfigPath: string, isConfigLocal: boolean, version?: string): Promise<SpawnResponse>
  • This API is used to spawn sequence manager if not spawned already and returns a promise of SpawnResponse.

    Parameters

    • agentPrefix: Prefix

      The prefix of the agent machine where sequence manager needs to be spawned.

    • obsModeConfigPath: string

      The path of the observation mode config path which should be present on agent machine or on config server.

    • isConfigLocal: boolean

      Boolean value to know if config file is present on local(agent) machine.

    • Optional version: string

      The sequence manager version. @default [3.0.0-M1]

    Returns Promise<SpawnResponse>

    SpawnResponse as Promise

Generated using TypeDoc