Type Alias Agent

type 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>;
}

Index

Methods

createAgentExportTemplate createAgentGroupExportTemplate createIdentityGatewayAgent createJavaAgent createWebAgent deleteAgent deleteAgents deleteIdentityGatewayAgent deleteIdentityGatewayAgents deleteJavaAgent deleteJavaAgents deleteWebAgent deleteWebAgents exportAgent exportAgentGroup exportAgentGroups exportAgents exportIdentityGatewayAgent exportIdentityGatewayAgents exportJavaAgent exportJavaAgents exportWebAgent exportWebAgents importAgent importAgentGroup importAgentGroups importAgents importIdentityGatewayAgent importIdentityGatewayAgents importJavaAgent importJavaAgents importWebAgent importWebAgents readAgent readAgentByTypeAndId readAgentGroup readAgentGroups readAgents readIdentityGatewayAgent readIdentityGatewayAgents readJavaAgent readJavaAgents readWebAgent readWebAgents updateIdentityGatewayAgent updateJavaAgent updateWebAgent

Deprecated

getAgent getAgentByTypeAndId getAgents getIdentityGatewayAgent getIdentityGatewayAgents getJavaAgent getJavaAgents getWebAgent getWebAgents putIdentityGatewayAgent putJavaAgent putWebAgent

Methods

createAgentExportTemplate

createAgentExportTemplate(): AgentExportInterface
Create an empty agent export template

Returns AgentExportInterface
an empty agent export template
- Defined in ops/AgentOps.ts:33

createAgentGroupExportTemplate

createAgentGroupExportTemplate(): AgentGroupExportInterface
Create an empty agent group export template

Returns AgentGroupExportInterface
an empty agent export template
- Defined in ops/AgentOps.ts:51

createIdentityGatewayAgent

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:101

createJavaAgent

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:132

createWebAgent

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:163

deleteAgent

deleteAgent(agentId: string): Promise<void>
Delete agent
Parameters
- agentId: string
  agent id/name
Returns Promise<void>
- Defined in ops/AgentOps.ts:319

deleteAgents

deleteAgents(): Promise<void>
Delete all agents

Returns Promise<void>
- Defined in ops/AgentOps.ts:314

deleteIdentityGatewayAgent

deleteIdentityGatewayAgent(agentId: string): Promise<void>
Delete identity gateway agent
Parameters
- agentId: string
  agent id/name
Returns Promise<void>
- Defined in ops/AgentOps.ts:328

deleteIdentityGatewayAgents

deleteIdentityGatewayAgents(): Promise<void>
Delete all identity gateway agents

Returns Promise<void>
- Defined in ops/AgentOps.ts:323

deleteJavaAgent

deleteJavaAgent(agentId: string): Promise<void>
Delete java agent
Parameters
- agentId: string
  agent id/name
Returns Promise<void>
- Defined in ops/AgentOps.ts:337

deleteJavaAgents

deleteJavaAgents(): Promise<void>
Delete all java agents

Returns Promise<void>
- Defined in ops/AgentOps.ts:332

deleteWebAgent

deleteWebAgent(agentId: string): Promise<void>
Delete web agent
Parameters
- agentId: string
  agent id/name
Returns Promise<void>
- Defined in ops/AgentOps.ts:346

deleteWebAgents

deleteWebAgents(): Promise<void>
Delete all web agents

Returns Promise<void>
- Defined in ops/AgentOps.ts:341

exportAgent

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:204

exportAgentGroup

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:68

exportAgentGroups

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:73

exportAgents

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:182

exportIdentityGatewayAgent

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:213

exportIdentityGatewayAgents

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:187

exportJavaAgent

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:219

exportJavaAgents

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:192

exportWebAgent

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:225

exportWebAgents

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:197

importAgent

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:266

importAgentGroup

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:277

importAgentGroups

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:241

importAgents

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:232

importIdentityGatewayAgent

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:287

importIdentityGatewayAgents

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:248

importJavaAgent

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:297

importJavaAgents

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:253

importWebAgent

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:307

importWebAgents

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:258

readAgent

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:46

readAgentByTypeAndId

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:80

readAgentGroup

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:57

readAgentGroups

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:62

readAgents

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:39

readIdentityGatewayAgent

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:94

readIdentityGatewayAgents

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:88

readJavaAgent

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:125

readJavaAgents

readJavaAgents(): Promise<AmConfigEntityInterface[]>
Read java agents

Returns Promise<AmConfigEntityInterface[]>
a promise that resolves to an array of J2EEAgent objects
- Defined in ops/AgentOps.ts:119

readWebAgent

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:156

readWebAgents

readWebAgents(): Promise<AmConfigEntityInterface[]>
Read web agents

Returns Promise<AmConfigEntityInterface[]>
a promise that resolves to an array of WebAgent objects
- Defined in ops/AgentOps.ts:150

updateIdentityGatewayAgent

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:111

updateJavaAgent

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:142

updateWebAgent

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:173

Deprecated

getAgent

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:370

getAgentByTypeAndId

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:382

getAgents

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:359

getIdentityGatewayAgent

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:406

getIdentityGatewayAgents

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:395

getJavaAgent

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:443

getJavaAgents

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:432

getWebAgent

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:480

getWebAgents

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:469

putIdentityGatewayAgent

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:419

putJavaAgent

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:456

putWebAgent

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:493

Type Alias Agent

Index

Methods

Deprecated

Methods

createAgentExportTemplate

Returns AgentExportInterface

createAgentGroupExportTemplate

Returns AgentGroupExportInterface

createIdentityGatewayAgent

Parameters

Returns Promise<AmConfigEntityInterface>

createJavaAgent

Parameters

Returns Promise<AmConfigEntityInterface>

createWebAgent

Parameters

Returns Promise<AmConfigEntityInterface>

deleteAgent

Parameters

Returns Promise<void>

deleteAgents

Returns Promise<void>

deleteIdentityGatewayAgent

Parameters

Returns Promise<void>

deleteIdentityGatewayAgents

Returns Promise<void>

deleteJavaAgent

Parameters

Returns Promise<void>

deleteJavaAgents

Returns Promise<void>

deleteWebAgent

Parameters

Returns Promise<void>

deleteWebAgents

Returns Promise<void>

exportAgent

Parameters

Returns Promise<AgentExportInterface>

exportAgentGroup

Parameters

Returns Promise<AgentGroupExportInterface>

exportAgentGroups

Returns Promise<AgentGroupExportInterface>

exportAgents

Parameters

Returns Promise<AgentExportInterface>

exportIdentityGatewayAgent

Parameters

Returns Promise<AgentExportInterface>

exportIdentityGatewayAgents

Returns Promise<AgentExportInterface>

exportJavaAgent

Parameters

Returns Promise<AgentExportInterface>

exportJavaAgents

Returns Promise<AgentExportInterface>

exportWebAgent

Parameters

Returns Promise<AgentExportInterface>

exportWebAgents

Returns Promise<AgentExportInterface>

importAgent

Parameters

Returns Promise<AmConfigEntityInterface>

importAgentGroup

Parameters

Returns Promise<AmConfigEntityInterface>

importAgentGroups

Parameters

Returns Promise<AmConfigEntityInterface[]>

importAgents

Parameters

Returns Promise<AmConfigEntityInterface[]>

importIdentityGatewayAgent

Parameters

Returns Promise<AmConfigEntityInterface>

importIdentityGatewayAgents