Type Alias Agent

Agent: {
    createAgentExportTemplate(): AgentExportInterface;
    createAgentGroupExportTemplate(): AgentGroupExportInterface;
    createIdentityGatewayAgent(
        gatewayId: string,
        gatewayData: AmConfigEntityInterface,
    ): Promise<AmConfigEntityInterface>;
    createJavaAgent(
        agentId: string,
        agentData: AmConfigEntityInterface,
    ): Promise<AmConfigEntityInterface>;
    createWebAgent(
        agentId: string,
        agentData: AmConfigEntityInterface,
    ): Promise<AmConfigEntityInterface>;
    deleteAgent(agentId: string): Promise<void>;
    deleteAgents(): Promise<void>;
    deleteIdentityGatewayAgent(agentId: string): Promise<void>;
    deleteIdentityGatewayAgents(): Promise<void>;
    deleteJavaAgent(agentId: string): Promise<void>;
    deleteJavaAgents(): Promise<void>;
    deleteWebAgent(agentId: string): Promise<void>;
    deleteWebAgents(): Promise<void>;
    exportAgent(
        agentId: string,
        globalConfig: boolean,
    ): Promise<AgentExportInterface>;
    exportAgentGroup(groupId: string): Promise<AgentGroupExportInterface>;
    exportAgentGroups(): Promise<AgentGroupExportInterface>;
    exportAgents(globalConfig: boolean): Promise<AgentExportInterface>;
    exportIdentityGatewayAgent(agentId: string): Promise<AgentExportInterface>;
    exportIdentityGatewayAgents(): Promise<AgentExportInterface>;
    exportJavaAgent(agentId: string): Promise<AgentExportInterface>;
    exportJavaAgents(): Promise<AgentExportInterface>;
    exportWebAgent(agentId: string): Promise<AgentExportInterface>;
    exportWebAgents(): Promise<AgentExportInterface>;
    getAgent(agentId: string): Promise<AmConfigEntityInterface>;
    getAgentByTypeAndId(
        agentType: AgentType,
        agentId: string,
    ): Promise<AmConfigEntityInterface>;
    getAgents(): Promise<AmConfigEntityInterface[]>;
    getIdentityGatewayAgent(
        gatewayId: string,
    ): Promise<AmConfigEntityInterface>;
    getIdentityGatewayAgents(): Promise<AmConfigEntityInterface[]>;
    getJavaAgent(agentId: string): Promise<AmConfigEntityInterface>;
    getJavaAgents(): Promise<AmConfigEntityInterface[]>;
    getWebAgent(agentId: string): Promise<AmConfigEntityInterface>;
    getWebAgents(): Promise<AmConfigEntityInterface[]>;
    importAgent(
        agentId: string,
        importData: AgentExportInterface,
        globalConfig: boolean,
    ): Promise<AmConfigEntityInterface>;
    importAgentGroup(
        agentGroupId: string,
        importData: AgentGroupExportInterface,
    ): Promise<AmConfigEntityInterface>;
    importAgentGroups(
        importData: AgentGroupExportInterface,
    ): Promise<AmConfigEntityInterface[]>;
    importAgents(
        importData: AgentExportInterface,
        globalConfig: boolean,
    ): Promise<AmConfigEntityInterface[]>;
    importIdentityGatewayAgent(
        agentId: string,
        importData: AgentExportInterface,
    ): Promise<AmConfigEntityInterface>;
    importIdentityGatewayAgents(
        importData: AgentExportInterface,
    ): Promise<void>;
    importJavaAgent(
        agentId: string,
        importData: AgentExportInterface,
    ): Promise<AmConfigEntityInterface>;
    importJavaAgents(importData: AgentExportInterface): Promise<void>;
    importWebAgent(
        agentId: string,
        importData: AgentExportInterface,
    ): Promise<AmConfigEntityInterface>;
    importWebAgents(importData: AgentExportInterface): Promise<void>;
    putIdentityGatewayAgent(
        gatewayId: string,
        gatewayData: AmConfigEntityInterface,
    ): Promise<AmConfigEntityInterface>;
    putJavaAgent(
        agentId: string,
        agentData: AmConfigEntityInterface,
    ): Promise<AmConfigEntityInterface>;
    putWebAgent(
        agentId: string,
        agentData: AmConfigEntityInterface,
    ): Promise<AmConfigEntityInterface>;
    readAgent(
        agentId: string,
        globalConfig: boolean,
    ): Promise<AmConfigEntityInterface>;
    readAgentByTypeAndId(
        agentType: AgentType,
        agentId: string,
    ): Promise<AmConfigEntityInterface>;
    readAgentGroup(groupId: string): Promise<AmConfigEntityInterface>;
    readAgentGroups(): Promise<AmConfigEntityInterface[]>;
    readAgents(globalConfig: boolean): Promise<AmConfigEntityInterface[]>;
    readIdentityGatewayAgent(
        gatewayId: string,
    ): Promise<AmConfigEntityInterface>;
    readIdentityGatewayAgents(): Promise<AmConfigEntityInterface[]>;
    readJavaAgent(agentId: string): Promise<AmConfigEntityInterface>;
    readJavaAgents(): Promise<AmConfigEntityInterface[]>;
    readWebAgent(agentId: string): Promise<AmConfigEntityInterface>;
    readWebAgents(): Promise<AmConfigEntityInterface[]>;
    updateIdentityGatewayAgent(
        gatewayId: string,
        gatewayData: AmConfigEntityInterface,
    ): Promise<AmConfigEntityInterface>;
    updateJavaAgent(
        agentId: string,
        agentData: AmConfigEntityInterface,
    ): Promise<AmConfigEntityInterface>;
    updateWebAgent(
        agentId: string,
        agentData: AmConfigEntityInterface,
    ): Promise<AmConfigEntityInterface>;
}

Type declaration

createAgentExportTemplate:function
- createAgentExportTemplate(): AgentExportInterface
  Create an empty agent export template
  
  Returns AgentExportInterface
  an empty agent export template
  - Defined in ops/AgentOps.ts:32
createAgentGroupExportTemplate:function
- createAgentGroupExportTemplate(): AgentGroupExportInterface
  Create an empty agent group export template
  
  Returns AgentGroupExportInterface
  an empty agent export template
  - Defined in ops/AgentOps.ts:50
createIdentityGatewayAgent:function
- createIdentityGatewayAgent(
  gatewayId: string,
  gatewayData: AmConfigEntityInterface,
  ): Promise<AmConfigEntityInterface>
  Create identity gateway agent
  Parameters
  - gatewayId: string
    gateway id
  - gatewayData: AmConfigEntityInterface
    IdentityGatewayAgent object
  Returns Promise<AmConfigEntityInterface>
  a promise that resolves to an object containing an IdentityGatewayAgent object
  - Defined in ops/AgentOps.ts:100
createJavaAgent:function
- createJavaAgent(
  agentId: string,
  agentData: AmConfigEntityInterface,
  ): Promise<AmConfigEntityInterface>
  Put java agent
  Parameters
  - agentId: string
    java agent id
  - agentData: AmConfigEntityInterface
    java agent object
  Returns Promise<AmConfigEntityInterface>
  a promise that resolves to an object containing an java agent object
  - Defined in ops/AgentOps.ts:131
createWebAgent:function
- createWebAgent(
  agentId: string,
  agentData: AmConfigEntityInterface,
  ): Promise<AmConfigEntityInterface>
  Create web agent
  Parameters
  - agentId: string
    web agent id
  - agentData: AmConfigEntityInterface
    WebAgent object
  Returns Promise<AmConfigEntityInterface>
  a promise that resolves to an object containing an WebAgent object
  - Defined in ops/AgentOps.ts:162
deleteAgent:function
- deleteAgent(agentId: string): Promise<void>
  Delete agent
  Parameters
  - agentId: string
    agent id/name
  Returns Promise<void>
  - Defined in ops/AgentOps.ts:318
deleteAgents:function
- deleteAgents(): Promise<void>
  Delete all agents
  
  Returns Promise<void>
  - Defined in ops/AgentOps.ts:313
deleteIdentityGatewayAgent:function
- deleteIdentityGatewayAgent(agentId: string): Promise<void>
  Delete identity gateway agent
  Parameters
  - agentId: string
    agent id/name
  Returns Promise<void>
  - Defined in ops/AgentOps.ts:327
deleteIdentityGatewayAgents:function
- deleteIdentityGatewayAgents(): Promise<void>
  Delete all identity gateway agents
  
  Returns Promise<void>
  - Defined in ops/AgentOps.ts:322
deleteJavaAgent:function
- deleteJavaAgent(agentId: string): Promise<void>
  Delete java agent
  Parameters
  - agentId: string
    agent id/name
  Returns Promise<void>
  - Defined in ops/AgentOps.ts:336
deleteJavaAgents:function
- deleteJavaAgents(): Promise<void>
  Delete all java agents
  
  Returns Promise<void>
  - Defined in ops/AgentOps.ts:331
deleteWebAgent:function
- deleteWebAgent(agentId: string): Promise<void>
  Delete web agent
  Parameters
  - agentId: string
    agent id/name
  Returns Promise<void>
  - Defined in ops/AgentOps.ts:345
deleteWebAgents:function
- deleteWebAgents(): Promise<void>
  Delete all web agents
  
  Returns Promise<void>
  - Defined in ops/AgentOps.ts:340
exportAgent:function
- exportAgent(
  agentId: string,
  globalConfig: boolean,
  ): Promise<AgentExportInterface>
  Export agent. The response can be saved to file as is.
  Parameters
  - agentId: string
    agent id/name
  - globalConfig: boolean
    true if global agent is the target of the operation, false otherwise. Default: false.
  Returns Promise<AgentExportInterface>
  Promise resolving to an AgentExportInterface object.
  - Defined in ops/AgentOps.ts:203
exportAgentGroup:function
- exportAgentGroup(groupId: string): Promise<AgentGroupExportInterface>
  Export a single agent group by id. The response can be saved to file as is.
  Parameters
  - groupId: string
    Group id
  Returns Promise<AgentGroupExportInterface>
  Promise resolving to a AgentGroupExportInterface object.
  - Defined in ops/AgentOps.ts:67
exportAgentGroups:function
- exportAgentGroups(): Promise<AgentGroupExportInterface>
  Export all agent groups. The response can be saved to file as is.
  
  Returns Promise<AgentGroupExportInterface>
  Promise resolving to a AgentGroupExportInterface object.
  - Defined in ops/AgentOps.ts:72
exportAgents:function
- exportAgents(globalConfig: boolean): Promise<AgentExportInterface>
  Export all agents. The response can be saved to file as is.
  Parameters
  - globalConfig: boolean
    true if global agent is the target of the operation, false otherwise. Default: false.
  Returns Promise<AgentExportInterface>
  Promise resolving to an AgentExportInterface object.
  - Defined in ops/AgentOps.ts:181
exportIdentityGatewayAgent:function
- exportIdentityGatewayAgent(agentId: string): Promise<AgentExportInterface>
  Export identity gateway agent. The response can be saved to file as is.
  Parameters
  - agentId: string
    agent id/name
  Returns Promise<AgentExportInterface>
  Promise resolving to an AgentExportInterface object.
  - Defined in ops/AgentOps.ts:212
exportIdentityGatewayAgents:function
- exportIdentityGatewayAgents(): Promise<AgentExportInterface>
  Export all identity gateway agents. The response can be saved to file as is.
  
  Returns Promise<AgentExportInterface>
  Promise resolving to an AgentExportInterface object.
  - Defined in ops/AgentOps.ts:186
exportJavaAgent:function
- exportJavaAgent(agentId: string): Promise<AgentExportInterface>
  Export java agent. The response can be saved to file as is.
  Parameters
  - agentId: string
    agent id/name
  Returns Promise<AgentExportInterface>
  Promise resolving to an AgentExportInterface object.
  - Defined in ops/AgentOps.ts:218
exportJavaAgents:function
- exportJavaAgents(): Promise<AgentExportInterface>
  Export all java agents. The response can be saved to file as is.
  
  Returns Promise<AgentExportInterface>
  Promise resolving to an AgentExportInterface object.
  - Defined in ops/AgentOps.ts:191
exportWebAgent:function
- exportWebAgent(agentId: string): Promise<AgentExportInterface>
  Export web agent. The response can be saved to file as is.
  Parameters
  - agentId: string
    agent id/name
  Returns Promise<AgentExportInterface>
  Promise resolving to an AgentExportInterface object.
  - Defined in ops/AgentOps.ts:224
exportWebAgents:function
- exportWebAgents(): Promise<AgentExportInterface>
  Export all web agents. The response can be saved to file as is.
  
  Returns Promise<AgentExportInterface>
  Promise resolving to an AgentExportInterface object.
  - Defined in ops/AgentOps.ts:196
getAgent:function
- getAgent(agentId: string): Promise<AmConfigEntityInterface>
  Get agent
  Parameters
  - agentId: string
    agent id/name
  Returns Promise<AmConfigEntityInterface>
  a promise that resolves to an agent object
  Deprecated
  since v2.0.0 use readAgent instead
  
  readAgent(agentId: string): Promise<AgentSkeleton>
  - Defined in ops/AgentOps.ts:369
getAgentByTypeAndId:function
- getAgentByTypeAndId(
  agentType: AgentType,
  agentId: string,
  ): Promise<AmConfigEntityInterface>
  Get agent by type and id
  Parameters
  - agentType: AgentType
    agent type (IdentityGatewayAgent, J2EEAgent, WebAgent)
  - agentId: string
    agent id/name
  Returns Promise<AmConfigEntityInterface>
  a promise that resolves to an agent object
  Deprecated
  since v2.0.0 use readAgentByTypeAndId instead
  
  readAgentByTypeAndId(agentType: AgentType, agentId: string): Promise<AgentSkeleton>
  - Defined in ops/AgentOps.ts:381
getAgents:function
- getAgents(): Promise<AmConfigEntityInterface[]>
  Get all agents.
  
  Returns Promise<AmConfigEntityInterface[]>
  a promise that resolves to an array of agent objects
  Deprecated
  since v2.0.0 use readAgents instead
  
  readAgents(): Promise<AgentSkeleton[]>
  - Defined in ops/AgentOps.ts:358
getIdentityGatewayAgent:function
- getIdentityGatewayAgent(gatewayId: string): Promise<AmConfigEntityInterface>
  Get identity gateway agent
  Parameters
  - gatewayId: string
    gateway id
  Returns Promise<AmConfigEntityInterface>
  a promise that resolves to an object containing an IdentityGatewayAgent object
  Deprecated
  since v2.0.0 use readIdentityGatewayAgent instead
  
  readIdentityGatewayAgent(gatewayId: string): Promise<AgentSkeleton>
  - Defined in ops/AgentOps.ts:405
getIdentityGatewayAgents:function
- getIdentityGatewayAgents(): Promise<AmConfigEntityInterface[]>
  Get identity gateway agents
  
  Returns Promise<AmConfigEntityInterface[]>
  a promise that resolves to an array of IdentityGatewayAgent objects
  Deprecated
  since v2.0.0 use readIdentityGatewayAgents instead
  
  readIdentityGatewayAgents(): Promise<AgentSkeleton[]>
  - Defined in ops/AgentOps.ts:394
getJavaAgent:function
- getJavaAgent(agentId: string): Promise<AmConfigEntityInterface>
  Get java agent
  Parameters
  - agentId: string
    java agent id
  Returns Promise<AmConfigEntityInterface>
  a promise that resolves to an object containing an J2EEAgent object
  Deprecated
  since v2.0.0 use readJavaAgent instead
  
  readJavaAgent(agentId: string): Promise<AgentSkeleton>
  - Defined in ops/AgentOps.ts:442
getJavaAgents:function
- getJavaAgents(): Promise<AmConfigEntityInterface[]>
  Get java agents
  
  Returns Promise<AmConfigEntityInterface[]>
  a promise that resolves to an array of J2EEAgent objects
  Deprecated
  since v2.0.0 use readJavaAgents instead
  
  readJavaAgents(): Promise<AgentSkeleton[]>
  - Defined in ops/AgentOps.ts:431
getWebAgent:function
- getWebAgent(agentId: string): Promise<AmConfigEntityInterface>
  Get web agent
  Parameters
  - agentId: string
    web agent id
  Returns Promise<AmConfigEntityInterface>
  a promise that resolves to an object containing an WebAgent object
  Deprecated
  since v2.0.0 use readWebAgent instead
  
  readWebAgent(agentId: string): Promise<AgentSkeleton>
  - Defined in ops/AgentOps.ts:479
getWebAgents:function
- getWebAgents(): Promise<AmConfigEntityInterface[]>
  Get web agents
  
  Returns Promise<AmConfigEntityInterface[]>
  a promise that resolves to an array of WebAgent objects
  Deprecated
  since v2.0.0 use readWebAgents instead
  
  readWebAgents(): Promise<AgentSkeleton[]>
  - Defined in ops/AgentOps.ts:468
importAgent:function
- importAgent(
      agentId: string,
      importData: AgentExportInterface,
      globalConfig: boolean,
  ): Promise<AmConfigEntityInterface>
  Import agent. The import data is usually read from an agent export file.
  Parameters
  - agentId: string
    agent id/name
  - importData: AgentExportInterface
    agent import data.
  - globalConfig: boolean
    true if global agent is the target of the operation, false otherwise. Default: false.
  Returns Promise<AmConfigEntityInterface>
  Promise resolving to an agent object.
  - Defined in ops/AgentOps.ts:265
importAgentGroup:function
- importAgentGroup(
  agentGroupId: string,
  importData: AgentGroupExportInterface,
  ): Promise<AmConfigEntityInterface>
  Import agent group. The import data is usually read from an agent group export file.
  Parameters
  - agentGroupId: string
    agent group id/name
  - importData: AgentGroupExportInterface
    agent group import data.
  Returns Promise<AmConfigEntityInterface>
  Promise resolving to an agent group object.
  - Defined in ops/AgentOps.ts:276
importAgentGroups:function
- importAgentGroups(
  importData: AgentGroupExportInterface,
  ): Promise<AmConfigEntityInterface[]>
  Import agents groups. The import data is usually read from an agent group export file.
  Parameters
  - importData: AgentGroupExportInterface
    agent import data.
  Returns Promise<AmConfigEntityInterface[]>
  The agent groups that were imported.
  - Defined in ops/AgentOps.ts:240
importAgents:function
- importAgents(
  importData: AgentExportInterface,
  globalConfig: boolean,
  ): Promise<AmConfigEntityInterface[]>
  Import agents. The import data is usually read from an agent export file.
  Parameters
  - importData: AgentExportInterface
    agent import data.
  - globalConfig: boolean
    true if global agent is the target of the operation, false otherwise. Default: false.
  Returns Promise<AmConfigEntityInterface[]>
  The agents that were imported.
  - Defined in ops/AgentOps.ts:231
importIdentityGatewayAgent:function
- importIdentityGatewayAgent(
  agentId: string,
  importData: AgentExportInterface,
  ): Promise<AmConfigEntityInterface>
  Import identity gateway agent. The import data is usually read from an agent export file.
  Parameters
  - agentId: string
    agent id/name
  - importData: AgentExportInterface
    agent import data.
  Returns Promise<AmConfigEntityInterface>
  Promise resolving to an agent object.
  - Defined in ops/AgentOps.ts:286
importIdentityGatewayAgents:function
- importIdentityGatewayAgents(importData: AgentExportInterface): Promise<void>
  Import identity gateway agents. The import data is usually read from an agent export file.
  Parameters
  - importData: AgentExportInterface
    agent import data.
  Returns Promise<void>
  - Defined in ops/AgentOps.ts:247
importJavaAgent:function
- importJavaAgent(
  agentId: string,
  importData: AgentExportInterface,
  ): Promise<AmConfigEntityInterface>
  Import java agent. The import data is usually read from an agent export file.
  Parameters
  - agentId: string
    agent id/name
  - importData: AgentExportInterface
    agent import data.
  Returns Promise<AmConfigEntityInterface>
  Promise resolving to an agent object.
  - Defined in ops/AgentOps.ts:296
importJavaAgents:function
- importJavaAgents(importData: AgentExportInterface): Promise<void>
  Import java agents. The import data is usually read from an agent export file.
  Parameters
  - importData: AgentExportInterface
    agent import data.
  Returns Promise<void>
  - Defined in ops/AgentOps.ts:252
importWebAgent:function
- importWebAgent(
  agentId: string,
  importData: AgentExportInterface,
  ): Promise<AmConfigEntityInterface>
  Import java agent. The import data is usually read from an agent export file.
  Parameters
  - agentId: string
    agent id/name
  - importData: AgentExportInterface
    agent import data.
  Returns Promise<AmConfigEntityInterface>
  Promise resolving to an agent object.
  - Defined in ops/AgentOps.ts:306
importWebAgents:function
- importWebAgents(importData: AgentExportInterface): Promise<void>
  Import web agents. The import data is usually read from an agent export file.
  Parameters
  - importData: AgentExportInterface
    agent import data.
  Returns Promise<void>
  - Defined in ops/AgentOps.ts:257
putIdentityGatewayAgent:function
- putIdentityGatewayAgent(
  gatewayId: string,
  gatewayData: AmConfigEntityInterface,
  ): Promise<AmConfigEntityInterface>
  Update or create identity gateway agent
  Parameters
  - gatewayId: string
    gateway id
  - gatewayData: AmConfigEntityInterface
    IdentityGatewayAgent object
  Returns Promise<AmConfigEntityInterface>
  a promise that resolves to an object containing an IdentityGatewayAgent object
  Deprecated
  since v2.0.0 use updateIdentityGatewayAgent or createIdentityGatewayAgent instead
  
  updateIdentityGatewayAgent(gatewayId: string, gatewayData: AgentSkeleton): Promise<AgentSkeleton> createIdentityGatewayAgent(gatewayId: string, gatewayData: AgentSkeleton): Promise<AgentSkeleton>
  - Defined in ops/AgentOps.ts:418
putJavaAgent:function
- putJavaAgent(
  agentId: string,
  agentData: AmConfigEntityInterface,
  ): Promise<AmConfigEntityInterface>
  Update or create java agent
  Parameters
  - agentId: string
    java agent id
  - agentData: AmConfigEntityInterface
    java agent object
  Returns Promise<AmConfigEntityInterface>
  a promise that resolves to an object containing an java agent object
  Deprecated
  since v2.0.0 use updateJavaAgent or createJavaAgent instead
  
  updateJavaAgent(agentId: string, agentData: AgentSkeleton): Promise<AgentSkeleton> createJavaAgent(agentId: string, agentData: AgentSkeleton): Promise<AgentSkeleton>
  - Defined in ops/AgentOps.ts:455
putWebAgent:function
- putWebAgent(
  agentId: string,
  agentData: AmConfigEntityInterface,
  ): Promise<AmConfigEntityInterface>
  Update or create web agent
  Parameters
  - agentId: string
    web agent id
  - agentData: AmConfigEntityInterface
    WebAgent object
  Returns Promise<AmConfigEntityInterface>
  a promise that resolves to an object containing an WebAgent object
  Deprecated
  since v2.0.0 use updateWebAgent or createWebAgent instead
  
  updateWebAgent(agentId: string, agentData: AgentSkeleton): Promise<AgentSkeleton> createWebAgent(agentId: string, agentData: AgentSkeleton): Promise<AgentSkeleton>
  - Defined in ops/AgentOps.ts:492
readAgent:function
- readAgent(
  agentId: string,
  globalConfig: boolean,
  ): Promise<AmConfigEntityInterface>
  Read agent
  Parameters
  - agentId: string
    agent id/name
  - globalConfig: boolean
    true if global agent is the target of the operation, false otherwise. Default: false.
  Returns Promise<AmConfigEntityInterface>
  a promise that resolves to an agent object
  - Defined in ops/AgentOps.ts:45
readAgentByTypeAndId:function
- readAgentByTypeAndId(
  agentType: AgentType,
  agentId: string,
  ): Promise<AmConfigEntityInterface>
  Read agent by type and id
  Parameters
  - agentType: AgentType
    agent type (IdentityGatewayAgent, J2EEAgent, WebAgent)
  - agentId: string
    agent id/name
  Returns Promise<AmConfigEntityInterface>
  a promise that resolves to an agent object
  - Defined in ops/AgentOps.ts:79
readAgentGroup:function
- readAgentGroup(groupId: string): Promise<AmConfigEntityInterface>
  Read agent group by id
  Parameters
  - groupId: string
    Group id
  Returns Promise<AmConfigEntityInterface>
  a promise that resolves to a agent group object
  - Defined in ops/AgentOps.ts:56
readAgentGroups:function
- readAgentGroups(): Promise<AmConfigEntityInterface[]>
  Read all agent groups.
  
  Returns Promise<AmConfigEntityInterface[]>
  a promise that resolves to an array of agent group objects
  - Defined in ops/AgentOps.ts:61
readAgents:function
- readAgents(globalConfig: boolean): Promise<AmConfigEntityInterface[]>
  Read all agents.
  Parameters
  - globalConfig: boolean
    true if global agent is the target of the operation, false otherwise. Default: false.
  Returns Promise<AmConfigEntityInterface[]>
  a promise that resolves to an array of agent objects
  - Defined in ops/AgentOps.ts:38
readIdentityGatewayAgent:function
- readIdentityGatewayAgent(gatewayId: string): Promise<AmConfigEntityInterface>
  Read identity gateway agent
  Parameters
  - gatewayId: string
    gateway id
  Returns Promise<AmConfigEntityInterface>
  a promise that resolves to an object containing an IdentityGatewayAgent object
  - Defined in ops/AgentOps.ts:93
readIdentityGatewayAgents:function
- readIdentityGatewayAgents(): Promise<AmConfigEntityInterface[]>
  Read identity gateway agents
  
  Returns Promise<AmConfigEntityInterface[]>
  a promise that resolves to an array of IdentityGatewayAgent objects
  - Defined in ops/AgentOps.ts:87
readJavaAgent:function
- readJavaAgent(agentId: string): Promise<AmConfigEntityInterface>
  Read java agent
  Parameters
  - agentId: string
    java agent id
  Returns Promise<AmConfigEntityInterface>
  a promise that resolves to an object containing an J2EEAgent object
  - Defined in ops/AgentOps.ts:124
readJavaAgents:function
- readJavaAgents(): Promise<AmConfigEntityInterface[]>
  Read java agents
  
  Returns Promise<AmConfigEntityInterface[]>
  a promise that resolves to an array of J2EEAgent objects
  - Defined in ops/AgentOps.ts:118
readWebAgent:function
- readWebAgent(agentId: string): Promise<AmConfigEntityInterface>
  Read web agent
  Parameters
  - agentId: string
    web agent id
  Returns Promise<AmConfigEntityInterface>
  a promise that resolves to an object containing an WebAgent object
  - Defined in ops/AgentOps.ts:155
readWebAgents:function
- readWebAgents(): Promise<AmConfigEntityInterface[]>
  Read web agents
  
  Returns Promise<AmConfigEntityInterface[]>
  a promise that resolves to an array of WebAgent objects
  - Defined in ops/AgentOps.ts:149
updateIdentityGatewayAgent:function
- updateIdentityGatewayAgent(
  gatewayId: string,
  gatewayData: AmConfigEntityInterface,
  ): Promise<AmConfigEntityInterface>
  Update or create identity gateway agent
  Parameters
  - gatewayId: string
    gateway id
  - gatewayData: AmConfigEntityInterface
    IdentityGatewayAgent object
  Returns Promise<AmConfigEntityInterface>
  a promise that resolves to an object containing an IdentityGatewayAgent object
  - Defined in ops/AgentOps.ts:110
updateJavaAgent:function
- updateJavaAgent(
  agentId: string,
  agentData: AmConfigEntityInterface,
  ): Promise<AmConfigEntityInterface>
  Put java agent
  Parameters
  - agentId: string
    java agent id
  - agentData: AmConfigEntityInterface
    java agent object
  Returns Promise<AmConfigEntityInterface>
  a promise that resolves to an object containing an java agent object
  - Defined in ops/AgentOps.ts:141
updateWebAgent:function
- updateWebAgent(
  agentId: string,
  agentData: AmConfigEntityInterface,
  ): Promise<AmConfigEntityInterface>
  Update or create web agent
  Parameters
  - agentId: string
    web agent id
  - agentData: AmConfigEntityInterface
    WebAgent object
  Returns Promise<AmConfigEntityInterface>
  a promise that resolves to an object containing an WebAgent object
  - Defined in ops/AgentOps.ts:172

Type Alias Agent

Type declaration

createAgentExportTemplate:function

Returns AgentExportInterface

createAgentGroupExportTemplate:function

Returns AgentGroupExportInterface

createIdentityGatewayAgent:function

Parameters

Returns Promise<AmConfigEntityInterface>

createJavaAgent:function

Parameters

Returns Promise<AmConfigEntityInterface>

createWebAgent:function

Parameters

Returns Promise<AmConfigEntityInterface>

deleteAgent:function

Parameters

Returns Promise<void>

deleteAgents:function

Returns Promise<void>

deleteIdentityGatewayAgent:function

Parameters

Returns Promise<void>

deleteIdentityGatewayAgents:function

Returns Promise<void>

deleteJavaAgent:function

Parameters

Returns Promise<void>

deleteJavaAgents:function

Returns Promise<void>

deleteWebAgent:function

Parameters

Returns Promise<void>

deleteWebAgents:function

Returns Promise<void>

exportAgent:function

Parameters

Returns Promise<AgentExportInterface>

exportAgentGroup:function

Parameters

Returns Promise<AgentGroupExportInterface>

exportAgentGroups:function

Returns Promise<AgentGroupExportInterface>

exportAgents:function

Parameters

Returns Promise<AgentExportInterface>

exportIdentityGatewayAgent:function

Parameters

Returns Promise<AgentExportInterface>

exportIdentityGatewayAgents:function

Returns Promise<AgentExportInterface>

exportJavaAgent:function

Parameters

Returns Promise<AgentExportInterface>

exportJavaAgents:function

Returns Promise<AgentExportInterface>

exportWebAgent:function

Parameters

Returns Promise<AgentExportInterface>

exportWebAgents:function

Returns Promise<AgentExportInterface>

getAgent:function

Parameters

Returns Promise<AmConfigEntityInterface>

Deprecated

getAgentByTypeAndId:function

Parameters

Returns Promise<AmConfigEntityInterface>

Deprecated

getAgents:function

Returns Promise<AmConfigEntityInterface[]>

Deprecated

getIdentityGatewayAgent:function

Parameters

Returns Promise<AmConfigEntityInterface>

Deprecated

getIdentityGatewayAgents:function

Returns Promise<AmConfigEntityInterface[]>

Deprecated

getJavaAgent:function