Skip to main content

Server-based Steps

Server-based steps were designed to allow the workflow developer to interrogate the vast knowledge that Avantra obtains about a managed object to control the flow of subsequent steps or to update Avantra based on the result of a workflow.

Consider a workflow example that has specific steps for Microsoft Windows vs Ubuntu installations. This can be guarded by an IF step to execute only the needed steps for the platform and a server-based step can be used to get the criteria needed to determine which branch to execute.

tip

Not all APIs are available for server-based steps compared to regular steps running on an agent. We provide the web API however all other managed object specific APIs (SAP RFC, Database queries, SAP Control, etc.) are not available and require a follow on step on the agent that manages that object.

Additionally, the avantra host object is only available when the 'Run on Avantra Server' option is selected in the step definition and cannot be used on an agent-based step.

Code Walkthrough​

Creating a server-based JavaScript step is easily accomplished from the Step Library. Simply select the 'Run on Avantra Server' checkbox in the step properties.

Interrogating managed objects​

Server-based steps have access to a rich API of information Avantra has collected about managed objects. This API is accessible via the global object avantra and the sub-object systems. From there you should select which type of object you wish to interrogate e.g. servers, databases or sapsystems. Each of these has two methods of retrieving an object:

  • getByName(..)
    Pass the name of the object, as recorded in Avantra, to get the managed object result.
  • getById(..)
    Pass the Avantra ID to retrieve the requested result. The Avantra ID can be found in the UI or is available when a system is used as input.
tip

It is possible for multiple objects to share the same name for some managed object types. Always prefer using getById(..) if possible.

The returned object has properties containing information that can be used to control subsequent steps by outputting additional information to the workflow variables that are used as input to following steps or as input to IF/LOOPS to make the workflow generic. Let's see this in action:

const s1 = avantra.systems.servers.getByName("eiger")
const d1 = avantra.systems.databases.getById(1148)

// Conditional logic based on memory assigned to server
if (s1.physicalMemory < 32 * 1024 * 1024) {
    // Low memory system, perform different logic...
    log.debug("low mem")
    action.output.low_mem = true

} else {
    // Standard logic
    log.debug("high mem")
    action.output.low_mem = false
}

// Format version information
log.debug(d1.databaseType + " " + d1.version)

// Interrogate the server of the database
action.output.server_id = d1.server.systemId
// d1.server is a server object and contains all the same information as
// a server retrieved by avantra.systems.server.getByName(..)
log.debug("Memory of database server: " + d1.server.physicalMemory)

Interrogating check results​

Check data can be interrogated from server-based steps also and there are multiple ways to do this depending on the use case. This API is accessible via the global object avantra and the sub-object checks. There are two method calls that can be used to list checks:

  • getByName(..)
    Pass the name of the check, as configured in Avantra, to get the all check results caused by a check with that name.
  • getById(..)
    Pass the check ID to retrieve the check result with this ID. If both a daily check and RTM check exist with the same ID, the RTM result is returned.

Let's take a look at an example where we ask for a specific check, in this case the built in check CPULOAD, filter on a specific status, and then output the result as a selector. This result would then be directly used as a variable for a loop and perform maintenance or additional processing on each system.

const allCPU = avantra.checks.getByName("CPULOAD")
log.debug("Total number of CPULOAD checks: " + allCPU.length)

action.output.warning_checks = allCPU
        // Filter the list for only those with a specific status
        .filter(cpu => cpu.status == avantra.Status.WARNING)
        // Collect only the systemIds for processing in the workflow
        .map(cpuCheck => cpuCheck.system.systemId)

// Debug: output the list of failed statuses
action.output.warning_checks.forEach(cpu => log.debug(cpu))
tip

The Avantra server-based API respects the customer chosen when executing the workflow. This means that the results will be limited to those systems/checks within that execution customer.

As you've seen above, you can read the system from the check result. This object contains the same information and properties as the systems API. Additionally, you can read the checks linked to a system using similar APIs o the system object using the getCheckByName(..) method or all checks via getChecks(..).

Evaluating system selectors​

System selectors are also available in server-based steps and can be accessed by via the global object avantra and the sub-object systems. There are then three options to retrieve a selector:

  • getSystemSelectorById(..)
    Retrieve a system selector by it's ID. The ID can be found in the Avantra UI. This method is preferred as it doesn't rely on the name or duplicate named selectors not existing.
  • findSystemSelectorsByName(..)
    If you need to retrieve the system selector by it's name only, you can do so using this method. However there might be multiple selectors with the same name depending on how the workflow is executed and this method returns a list of matching selectors.
  • findFirstSystemSelectorsByName(..)
    If you need to retrieve the system selector by it's name and you are only interested in the first item, this method will do that or return null if there are no matches.

A system selector can optionally be queried for customer, description, name etc. that would be entered in the UI. See SystemSelector for more information.

Ultimately, you can execute the system selector to return a list of system objects with the same properties as querying systems individually as well as their check information. In this way you can provide custom, enhanced system selector logic for subsequent steps in the workflow.

const abapSysSelector = avantra.systems.findFirstSystemSelectorsByName("ABAP Systems")
if (abapSysSelector) {

    const sysList = abapSysSelector.list()
    log.debug("Number of systems found by selector: " + sysList.length)

    // Give me all the systems in this selector that have the system role "Education"
    //    OR, have a NumberRanges check that is CRITICAL
    action.output.abap_list = sysList
                    .filter(abap => abap.systemRoleName == "Education" ||
                        (abap.getCheckByName("NumberRanges").length > 0 &&
                         abap.getCheckByName("NumberRanges")[0].status == avantra.Status.CRITICAL))
                    .map(abap => abap.systemId)

    action.output.abap_list
           .forEach(abap => log.debug(abap))

} else {
    // System selector not found!!
    action.output.abap_list = []
    action.success = false
    action.message = "No system selector found!!"
}

Creating external check results​

External check results can be created through the server-based steps as a result of previous steps or using information from external sources such as the web API.

An external check result is created via the global object avantra, the sub-object checks and the createExternalCheck(..) function by passing the name of the external check to be created.

const myExternalCheck = avantra.checks.createExternalCheck("External check name")

Other information can then be attached to the external check object returned, such as the status and any message you wish to display in the UI.

myExternalCheck.message = "This was not successful!!!"
myExternalCheck.status = avantra.Status.WARNING

The external check is then attached to a system object retrieved by one of the various methods described so far (by ID, check, selector etc.). For example:

avantra.systems.getById(182).attachExternalCheck(myExternalCheck)

External checks can also be removed from an object with a similar API call:

avantra.systems.getById(182).detachExternalCheck("External check name")

A more complete example would be:

const myExternalCheck = avantra.checks.createExternalCheck("External check name")

myExternalCheck.message = action.input.check_message
myExternalCheck.status = avantra.Status.WARNING

avantra.systems.getById(action.input.system).attachExternalCheck(myExternalCheck)

API Reference​

Global Variable avantra​

Avantra Server Script API

applicationVersion​

applicationVersion(): string

Returns the current version of the application.

Since: 24.1

Returns: string - an instance of String

currentTimeMillis​

currentTimeMillis(): number

Returns the current time in milliseconds.

Since: 24.1

Returns: number - an instance of long

currentTimestamp​

currentTimestamp(): string

Returns the current timestamp in format: YYYY-MM-dd HH:mm:ss

Since: 24.1

Returns: string - an instance of String

sleep​

sleep(milliseconds: number): void

Causes the current script execution to sleep for the specified number of milliseconds. It is highly recommended to use this sleep function to pause a script execution.

Since: 25.3

Parameters

  • milliseconds (number) - the length of time to sleep in milliseconds

CheckKind​

readonly CheckKind: CheckKind

Type: CheckKind

Modifiers: readonly

CloudType​

readonly CloudType: CloudType

Type: CloudType

Modifiers: readonly

DatabaseKind​

readonly DatabaseKind: DatabaseKind

Type: DatabaseKind

Modifiers: readonly

Modifiable​

readonly Modifiable: Modifiable

Type: Modifiable

Modifiers: readonly

NoteImplementationStatus​

readonly NoteImplementationStatus: NoteImplementationStatus

Type: NoteImplementationStatus

Modifiers: readonly

NoteStatus​

readonly NoteStatus: NoteStatus

Type: NoteStatus

Modifiers: readonly

OfflineBackupState​

readonly OfflineBackupState: OfflineBackupState

Type: OfflineBackupState

Modifiers: readonly

ProductVersionStatus​

readonly ProductVersionStatus: ProductVersionStatus

Type: ProductVersionStatus

Modifiers: readonly

S4HType​

readonly S4HType: S4HType

Type: S4HType

Modifiers: readonly

Status​

readonly Status: Status

Type: Status

Modifiers: readonly

SystemType​

readonly SystemType: SystemType

Type: SystemType

Modifiers: readonly

VmWarePowerState​

readonly VmWarePowerState: VmWarePowerState

Type: VmWarePowerState

Modifiers: readonly

checks​

readonly checks: NamespaceChecks

Namespace: checks

Type: NamespaceChecks

Modifiers: readonly

Since: 24.2

credentials​

readonly credentials: NamespaceCredentials

Namespace: credentials

Type: NamespaceCredentials

Modifiers: readonly

Since: 25.1

sapnotes​

readonly sapnotes: NamespaceSAPNotes

Namespace: sapnotes

Type: NamespaceSAPNotes

Modifiers: readonly

Since: 25.2

systems​

readonly systems: NamespaceSystems

Namespace: systems

Type: NamespaceSystems

Modifiers: readonly

Since: 24.2

Class AbapSoftwareComponent​

software component

description​

description: string

description

Type: string

Since: 24.2

latestPatch​

latestPatch: string

latest patch

Type: string

Since: 24.2

name​

name: string

name

Type: string

Since: 24.2

patchImplementationDate​

patchImplementationDate: Date

patch implementation date

Type: Date

Since: 24.2

patchLevel​

patchLevel: number

patch level

Type: number

Since: 24.2

release​

release: string

release

Type: string

Since: 24.2

type​

type: string

type

Type: string

Since: 24.2

Class AvantraTransport​

Avantra transport

client​

client: string

client

Type: string

Since: 24.2

date​

date: Date

date

Type: Date

Since: 24.2

description​

description: string

description

Type: string

Since: 24.2

transport​

transport: string

transport

Type: string

Since: 24.2

Class AwsCloudInfo​

AWS cloud info

amiId​

amiId: string

ami id

Type: string

Since: 24.3

instanceId​

instanceId: string

instance id

Type: string

Since: 24.3

instanceType​

instanceType: string

instance type

Type: string

Since: 24.3

region​

region: string

region

Type: string

Since: 24.3

zone​

zone: string

zone

Type: string

Since: 24.3

Class AzureCloudInfo​

Azure cloud info

location​

location: string

location

Type: string

Since: 24.3

offer​

offer: string

offer

Type: string

Since: 24.3

osType​

osType: string

os type

Type: string

Since: 24.3

publisher​

publisher: string

publisher

Type: string

Since: 24.3

resourceGroupName​

resourceGroupName: string

resource group name

Type: string

Since: 24.3

subscriptionId​

subscriptionId: string

subscription id

Type: string

Since: 24.3

version​

version: string

version

Type: string

Since: 24.3

vmId​

vmId: string

vm id

Type: string

Since: 24.3

vmSize​

vmSize: string

vm size

Type: string

Since: 24.3

Class BTPCloudFoundryCredential​

BTP CloudFoundry credential object, provides access to credential details

origin​

origin: string

origin

Type: string

Since: 25.1

password​

password: string

password

Type: string

Since: 25.1

username​

username: string

username

Type: string

Since: 25.1

Class BasicAuthCredential​

Basic authentication credential object, provides access to credential details

password​

password: string

password

Type: string

Since: 25.1

username​

username: string

username

Type: string

Since: 25.1

Class Check​

check

getConfirmationUser​

getConfirmationUser(): User

Since: 24.2

Returns: User - confirmation user

See Also: confirmationUser

getCustomer​

getCustomer(): Customer

Since: 24.2

Returns: Customer - customer

See Also: customer

getResult​

getResult(): string

Since: 24.2

Returns: string - check result

See Also: result

getSystem​

getSystem(): MonitoredSystem

Since: 24.2

Returns: MonitoredSystem - monitored system

See Also: system

isNotificationDisabled​

isNotificationDisabled(): Boolean

Since: 24.2

Returns: Boolean - true if notification is disabled

See Also: notificationDisabled

resultObject​

resultObject(): JSCheckResult

Return the typed check result.

Since: 25.0

Returns: JSCheckResult - the check result

category​

category: string

category

Type: string

Since: 24.2

checkType​

checkType: string

check type

Type: string

Since: 24.2

checkedWhileMonitoringOff​

checkedWhileMonitoringOff: Boolean

checked while monitoring off

Type: Boolean

Since: 24.2

compositeCheckId​

compositeCheckId: number

composite check id

Type: number

Since: 24.2

confirmationDateMillis​

confirmationDateMillis: number

confirmation date (milliseconds)

Type: number

Since: 24.2

confirmationMessage​

confirmationMessage: string

confirmation message

Type: string

Since: 24.2

confirmationUntilMillis​

confirmationUntilMillis: number

confirmation until (milliseconds)

Type: number

Since: 24.2

confirmationUser​

readonly confirmationUser: User

Accessors

Type: User

Modifiers: readonly

Since: 24.2

confirmed​

confirmed: boolean

confirmed

Type: boolean

Since: 24.2

customCheckId​

customCheckId: number

custom check id

Type: number

Since: 24.2

customer​

readonly customer: Customer

Accessors

Type: Customer

Modifiers: readonly

Since: 24.2

cycleTimeMin​

cycleTimeMin: number

cycle time (minutes)

Type: number

Since: 24.2

forceNotify​

forceNotify: Boolean

force notify

Type: Boolean

Since: 24.2

id​

id: number

id

Type: number

Since: 24.2

kind​

kind: CheckKind

kind

Type: CheckKind

Since: 24.2

monitoring​

monitoring: boolean

monitoring

Type: boolean

Since: 24.2

name​

name: string

name

Type: string

Since: 24.2

notificationDisabled​

readonly notificationDisabled: Boolean

Accessors

Type: Boolean

Modifiers: readonly

Since: 24.2

refreshAgeInMillis​

refreshAgeInMillis: number

refrish age (milliseconds)

Type: number

Since: 24.2

result​

readonly result: string

Accessors

Type: string

Modifiers: readonly

Since: 24.2

status​

status: Status

status

Type: Status

Since: 24.2

statusAgeInMillis​

statusAgeInMillis: number

status age (milliseconds)

Type: number

Since: 24.2

system​

readonly system: MonitoredSystem

Accessors

Type: MonitoredSystem

Modifiers: readonly

Since: 24.2

timestamp​

timestamp: Date

timestamp

Type: Date

Since: 24.2

Class CloudInfo​

cloud info

asAwsCloudInfo​

asAwsCloudInfo(): AwsCloudInfo

Cast to aws cloud info. Returns null if not possible.

Since: 24.3

Returns: AwsCloudInfo - aws cloud info

asAzureCloudInfo​

asAzureCloudInfo(): AzureCloudInfo

Cast to azure cloud info. Returns null if not possible.

Since: 24.3

Returns: AzureCloudInfo - azure cloud info

asFakeCloudInfo​

asFakeCloudInfo(): FakeCloudInfo

Cast to fake cloud info. Returns null if not possible.

Since: 24.3

Returns: FakeCloudInfo - fake cloud info

asGoogleCloudInfo​

asGoogleCloudInfo(): GoogleCloudInfo

Cast to google cloud info. Returns null if not possible.

Since: 24.3

Returns: GoogleCloudInfo - google cloud info

asVmWareCloudInfo​

asVmWareCloudInfo(): VmWareCloudInfo

Cast to VMware cloud info. Returns null if not possible.

Since: 24.3

Returns: VmWareCloudInfo - VMware cloud info

name​

name: string

name

Type: string

Since: 24.3

type​

type: CloudType

type

Type: CloudType

Since: 24.3

Class CpuInfo​

cpu info

mhz​

mhz: number

mhz

Type: number

Since: 24.3

model​

model: string

model

Type: string

Since: 24.3

name​

name: string

name

Type: string

Since: 24.3

totalCores​

totalCores: number

total cores

Type: number

Since: 24.3

vendor​

vendor: string

vendor

Type: string

Since: 24.3

Class Credential​

Credential object, provides access to credential details

asBTPCloudFoundryCredential​

asBTPCloudFoundryCredential(): BTPCloudFoundryCredential

Cast to BTP Cloud Foundry credential. Returns null if not possible.

Since: 25.1

Returns: BTPCloudFoundryCredential - BTP Cloud Foundry credential

asBasicAuthCredential​

asBasicAuthCredential(): BasicAuthCredential

Cast to basic auth credential. Returns null if not possible.

Since: 25.1

Returns: BasicAuthCredential - basic auth credential

asOAuthAuthorizationCodeProfileCredential​

asOAuthAuthorizationCodeProfileCredential(): OAuthAuthorizationCodeProfileCredential

Cast to OAuthAuthorizationCodeProfile credential. Returns null if not possible.

Since: 25.1

Returns: OAuthAuthorizationCodeProfileCredential - OAuthAuthorizationCodeProfile credential

asOAuthClientCredentialsProfileCredential​

asOAuthClientCredentialsProfileCredential(): OAuthClientCredentialsProfileCredential

Cast to OAuthClientCredentialsProfile credential. Returns null if not possible.

Since: 25.1

Returns: OAuthClientCredentialsProfileCredential - OAuthClientCredentialsProfile credential

asRFCCredential​

asRFCCredential(): RFCCredential

Cast to RFC credential. Returns null if not possible.

Since: 25.1

Returns: RFCCredential - RFC credential

asSAPCONTROLAuthenticationCredential​

asSAPCONTROLAuthenticationCredential(): SAPCONTROLAuthenticationCredential

Cast to SAPCONTROLAuthentication credential. Returns null if not possible.

Since: 25.1

Returns: SAPCONTROLAuthenticationCredential - SAPCONTROLAuthentication credential

asSAPHostCONTROLAuthenticationCredential​

asSAPHostCONTROLAuthenticationCredential(): SAPHostCONTROLAuthenticationCredential

Cast to SAPHostCONTROLAuthentication credential. Returns null if not possible.

Since: 25.1

Returns: SAPHostCONTROLAuthenticationCredential - SAPHostCONTROLAuthentication credential

asSSHCredential​

asSSHCredential(): SSHCredential

Cast to SSH credential. Returns null if not possible.

Since: 25.1

Returns: SSHCredential - SSH credential

Class CredentialProxy​

Object representing an Avantra credential which can provide encrypted credentials used in openConnection call. Please note: this object does not provide direct access to decrypted credentials. In case you need decrypted credentials, use the function decrypt() on a credential to get a map with decrpyted credentials. However, decrypting credentials is disabled by default and must be actively enabled.

canDecrypt​

canDecrypt(): boolean

Check whether this credential can be decrypted or not

if(cred.canDecrypt()){
}

decrypt​

decrypt(): Credential

Function to decrypt credentials. This function checks whether permissions can be decrypted or not. In case credentials cannot be decrypted, an error is thrown.

The returned object is a provides direct access to the specific credential settings.

const decryptedCred = cred.decrypt();
var username = decryptedCred.asBasicAuthCredential().getUsername()
var password = decryptedCred.asBasicAuthCredential().getPassword()

Class Customer​

customer

address​

address: string

address

Type: string

Since: 24.2

city​

city: string

city

Type: string

Since: 24.2

countryCode​

countryCode: string

country

Type: string

Since: 24.2

customData​

customData: object

custom data

Type: object

Since: 24.2

customerId​

customerId: number

customer id

Type: number

Since: 24.2

description​

description: string

description

Type: string

Since: 24.2

email​

email: string

email

Type: string

Since: 24.2

fax​

fax: string

fax number

Type: string

Since: 24.2

fixPhone​

fixPhone: string

phone number

Type: string

Since: 24.2

guid​

guid: string

unique id

Type: string

Since: 24.2

mobilePhone​

mobilePhone: string

mobile phone number

Type: string

Since: 24.2

name​

name: string

name

Type: string

Since: 24.2

poBox​

poBox: string

po box

Type: string

Since: 24.2

postalCode​

postalCode: string

postal code

Type: string

Since: 24.2

remarks​

remarks: string

remarks

Type: string

Since: 24.2

sapCustomerNumber​

sapCustomerNumber: string

sap customer number

Type: string

Since: 24.2

timestamp​

timestamp: Date

timestamp

Type: Date

Since: 24.2

timezone​

timezone: string

timezone

Type: string

Since: 24.2

url​

url: string

url

Type: string

Since: 24.2

Class Database​

database

canWrite​

canWrite(): boolean

Since: 25.1

Returns: boolean - true if write statements are enabled to that database, otherwise false

getBusinessObjects​

getBusinessObjects(): SapBusinessObject[]

business object from the database

Since: 24.2

See Also: businessObjects

getSapSystem​

getSapSystem(): SapSystem

Since: 24.2

Returns: SapSystem - sap system of the database

See Also: sapSystem

getServer​

getServer(): Server

Since: 24.2

Returns: Server - the databases server

See Also: server

getSystemDatabase​

getSystemDatabase(): Database

Since: 24.2

Returns: Database - the system database

See Also: systemDatabase

attributes​

attributes: string

attributes

Type: string

Since: 24.2

businessObjects​

readonly businessObjects: SapBusinessObject[]

business object from the database

Accessors

Type: SapBusinessObject[]

Modifiers: readonly

Since: 24.2

databaseHost​

databaseHost: string

database host

Type: string

Since: 24.2

databaseName​

databaseName: string

name

Type: string

Since: 24.2

databasePort​

databasePort: number

database port

Type: number

Since: 24.2

databaseType​

databaseType: string

type

Type: string

Since: 24.2

dbmsProduct​

dbmsProduct: string

dbms

Type: string

Since: 24.2

kind​

kind: DatabaseKind

kind

Type: DatabaseKind

Since: 24.2

sapSystem​

readonly sapSystem: SapSystem

Accessors

Type: SapSystem

Modifiers: readonly

Since: 24.2

server​

readonly server: Server

Accessors

Type: Server

Modifiers: readonly

Since: 24.2

systemDatabase​

readonly systemDatabase: Database

Accessors

Type: Database

Modifiers: readonly

Since: 24.2

version​

version: string

version

Type: string

Since: 24.2

Class DnsDomain​

dns domain

domainId​

domainId: number

domain id

Type: number

Since: 24.2

name​

name: string

name

Type: string

Since: 24.2

timestamp​

timestamp: Date

timestamp

Type: Date

Since: 24.2

Class ExternalCheck​

external check

message​

message: string

message

Type: string

Since: 24.2

name​

name: string

name

Type: string

Since: 24.2

status​

status: Status

status

Type: Status

Since: 24.2

Class FakeCloudInfo​

fake cloud info

id​

id: string

Type: string

Since: 24.3

Class GoogleCloudInfo​

Google cloud info

id​

id: string

id

Type: string

Since: 24.3

projectId​

projectId: string

project id

Type: string

Since: 24.3

zone​

zone: string

zone

Type: string

Since: 24.3

Class J2eeSoftwareComponent​

j2ee component

applied​

applied: Date

applied

Type: Date

Since: 24.2

location​

location: string

location

Type: string

Since: 24.2

name​

name: string

name

Type: string

Since: 24.2

vendor​

vendor: string

vendor

Type: string

Since: 24.2

version​

version: string

version

Type: string

Since: 24.2

Class JSCheckResult​

The check result

copy​

copy(): JSCheckResult

Produce a copy of this check result.

Since: 25.0

Returns: JSCheckResult - the copy

findFirstTableOfSubResult​

findFirstTableOfSubResult(): JSCheckResultTable

Get the first table of a sub result

Since: 25.1

Returns: JSCheckResultTable - the first table of a sub result

getMessage​

getMessage(): string

The message property

Since: 25.0

Returns: string - the message

See Also: message

getName​

getName(): string

The name property

Since: 25.0

Returns: string - the name

See Also: name

getStatus​

getStatus(): avantra.Status

The status property

Since: 25.0

Returns: Status - the status

See Also: status

getSubResults​

getSubResults(): JSCheckSubResult[]

The subResults property

Since: 25.0

Returns: JSCheckSubResult[] - the subResults

See Also: subResults

resultType​

resultType(): JSCheckResultType

Get the type of the check result.

Since: 25.0

Returns: JSCheckResultType - the type of the result (PLAIN,XHTML,DATA)

setMessage​

setMessage(message: string): void

Since: 25.0

Parameters

  • message (string) - the message

See Also: message

setName​

setName(name: string): void

Since: 25.0

Parameters

  • name (string) - the name

See Also: name

setStatus​

setStatus(status: Status): void

Since: 25.0

Parameters

  • status (Status) - the status

See Also: status

setSubResults​

setSubResults(subResults: JSCheckSubResult[]): void

Since: 25.0

Parameters

See Also: subResults

message​

message: string

The message property

Accessors

Type: string

Since: 25.0

name​

name: string

The name property

Accessors

Type: string

Since: 25.0

status​

status: Status

The status property

Accessors

Type: Status

Since: 25.0

subResults​

subResults: JSCheckSubResult[]

The subResults property

Accessors

Type: JSCheckSubResult[]

Since: 25.0

Class JSCheckResultTable​

The check result table

copy​

copy(): JSCheckResultTable

Produce a copy of this table.

Since: 25.0

Returns: JSCheckResultTable - the copy

getColumns​

getColumns(): JSCheckResultTableColumn[]

The columns property

Since: 25.0

Returns: JSCheckResultTableColumn[] - the columns

See Also: columns

getRows​

getRows(): JSCheckResultTableRow[]

The rows property

Since: 25.0

Returns: JSCheckResultTableRow[] - the rows

See Also: rows

removeMatchingRow​

removeMatchingRow(predicate: Predicate<JSCheckResultTableRow>): void

Remove all rows from this table that match the predicate.

Since: 25.0

Parameters

  • predicate (Predicate<JSCheckResultTableRow>) - the predicate

setColumns​

setColumns(columns: JSCheckResultTableColumn[]): void

Since: 25.0

Parameters

See Also: columns

setRows​

setRows(rows: JSCheckResultTableRow[]): void

Since: 25.0

Parameters

See Also: rows

columns​

columns: JSCheckResultTableColumn[]

The columns property

Accessors

Type: JSCheckResultTableColumn[]

Since: 25.0

rows​

rows: JSCheckResultTableRow[]

The rows property

Accessors

Type: JSCheckResultTableRow[]

Since: 25.0

Class JSCheckResultTableCell​

The check result table cell

copy​

copy(): JSCheckResultTableCell

Produce a copy of this table cell.

Since: 25.0

Returns: JSCheckResultTableCell - the copy

getIcon​

getIcon(): string

The icon property

Since: 25.0

Returns: string - the icon

See Also: icon

getStatus​

getStatus(): avantra.Status

The status property

Since: 25.0

Returns: Status - the status

See Also: status

getTooltip​

getTooltip(): string

The tooltip property

Since: 25.0

Returns: string - the tooltip

See Also: tooltip

getValue​

getValue(): string

The value property

Since: 25.0

Returns: string - the value

See Also: value

setIcon​

setIcon(icon: string): void

Since: 25.0

Parameters

  • icon (string) - the icon

See Also: icon

setStatus​

setStatus(status: Status): void

Since: 25.0

Parameters

  • status (Status) - the status

See Also: status

setTooltip​

setTooltip(tooltip: string): void

Since: 25.0

Parameters

  • tooltip (string) - the tooltip

See Also: tooltip

setValue​

setValue(value: string): void

Since: 25.0

Parameters

  • value (string) - the value

See Also: value

icon​

icon: string

The icon property

Accessors

Type: string

Since: 25.0

status​

status: Status

The status property

Accessors

Type: Status

Since: 25.0

tooltip​

tooltip: string

The tooltip property

Accessors

Type: string

Since: 25.0

value​

value: string

The value property

Accessors

Type: string

Since: 25.0

Class JSCheckResultTableColumn​

The check result table cell

copy​

copy(): JSCheckResultTableColumn

Produce a copy of this table column.

Since: 25.0

Returns: JSCheckResultTableColumn - the copy

getName​

getName(): string

The name property

Since: 25.0

Returns: string - the name

See Also: name

getType​

getType(): string

The type property

Since: 25.0

Returns: string - the type

See Also: type

setName​

setName(name: string): void

Since: 25.0

Parameters

  • name (string) - the name

See Also: name

setType​

setType(type: string): void

Since: 25.0

Parameters

  • type (string) - the type

See Also: type

name​

name: string

The name property

Accessors

Type: string

Since: 25.0

type​

type: string

The type property

Accessors

Type: string

Since: 25.0

Class JSCheckResultTableRow​

The check result table row

copy​

copy(): JSCheckResultTableRow

Produce a copy of this table row.

Since: 25.0

Returns: JSCheckResultTableRow - the copy

findCellByName​

findCellByName(name: string): JSCheckResultTableCell

Try to find a table cell in this row by name.

Since: 25.0

Parameters

  • name (string) - the name

Returns: JSCheckResultTableCell - the cell if found

getCells​

getCells(): JSCheckResultTableCell[]

The cells property

Since: 25.0

Returns: JSCheckResultTableCell[] - the cells

See Also: cells

getStatus​

getStatus(): avantra.Status

The status property

Since: 25.0

Returns: Status - the status

See Also: status

setCells​

setCells(cells: JSCheckResultTableCell[]): void

Since: 25.0

Parameters

See Also: cells

setStatus​

setStatus(status: Status): void

Since: 25.0

Parameters

  • status (Status) - the status

See Also: status

cells​

cells: JSCheckResultTableCell[]

The cells property

Accessors

Type: JSCheckResultTableCell[]

Since: 25.0

status​

status: Status

The status property

Accessors

Type: Status

Since: 25.0

Class JSCheckSubResult​

The check sub-result

copy​

copy(): JSCheckSubResult

Produce a copy of this check sub-result.

Since: 25.0

Returns: JSCheckSubResult - the copy

getMessage​

getMessage(): string

The message property

Since: 25.0

Returns: string - the message

See Also: message

getName​

getName(): string

The name property

Since: 25.0

Returns: string - the name

See Also: name

getStatus​

getStatus(): avantra.Status

The status property

Since: 25.0

Returns: Status - the status

See Also: status

getTable​

getTable(): JSCheckResultTable

The subresult's table

Since: 25.0

Returns: JSCheckResultTable - the subResults

See Also: table

setMessage​

setMessage(message: string): void

Since: 25.0

Parameters

  • message (string) - the message

See Also: message

setName​

setName(name: string): void

Since: 25.0

Parameters

  • name (string) - the name

See Also: name

setStatus​

setStatus(status: Status): void

Since: 25.0

Parameters

  • status (Status) - the status

See Also: status

setTable​

setTable(table: JSCheckResultTable): void

Since: 25.0

Parameters

See Also: table

message​

message: string

The message property

Accessors

Type: string

Since: 25.0

name​

name: string

The name property

Accessors

Type: string

Since: 25.0

status​

status: Status

The status property

Accessors

Type: Status

Since: 25.0

table​

table: JSCheckResultTable

The subresult's table

Accessors

Type: JSCheckResultTable

Since: 25.0

Class MonitoredSystem​

monitored system

attachExternalCheck​

attachExternalCheck(externalCheck: ExternalCheck): void

Since: 24.2

Parameters

  • externalCheck (ExternalCheck) - the external check to attach to the system

detachExternalCheck​

detachExternalCheck(checkName: string): void

Since: 24.2

Parameters

  • checkName (string) - name of external check to detach from the system

getAdministrator​

getAdministrator(): User

Since: 24.2

Returns: User - administrator of the system

See Also: administrator

getApplicationTypeName​

getApplicationTypeName(): string

Since: 24.2

Returns: string - application type name

See Also: applicationTypeName

getCheckByName​

getCheckByName(name: string): Check[]

Since: 24.2

Parameters

  • name (string) - check name

Returns: Check[] - check of the system

getChecks​

getChecks(): Check[]

Since: 24.2

Returns: Check[] - checks of the system

See Also: checks

getCustomAttributes​

getCustomAttributes(): any

Since: 25.1

Returns: object - custom attributes

See Also: customAttributes

getCustomer​

getCustomer(): Customer

Since: 24.2

Returns: Customer - customer of the system

See Also: customer

getDeputy​

getDeputy(): User

Since: 24.2

Returns: User - deputy of the system

See Also: deputy

getMoniParam​

getMoniParam(name: string): string

Retrieve the monitoring parameter by name for this system.

Since: 24.3

Parameters

  • name (string) - the name of the monitored parameter to retrieve

Returns: string - the monitored parameter or null if not found

getSla​

getSla(): SLA

Since: 25.1

Returns: SLA - service level agreement (SLA)

See Also: sla

getSystemRoleName​

getSystemRoleName(): string

Since: 24.2

Returns: string - system role name

See Also: systemRoleName

administrator​

readonly administrator: User

Accessors

Type: User

Modifiers: readonly

Since: 24.2

applicationTypeName​

readonly applicationTypeName: string

Accessors

Type: string

Modifiers: readonly

Since: 24.2

checks​

readonly checks: Check[]

Accessors

Type: Check[]

Modifiers: readonly

Since: 24.2

customAttributes​

readonly customAttributes: object

Accessors

Type: object

Modifiers: readonly

Since: 25.1

customData​

customData: object

custom data

Type: object

Since: 24.2

customer​

readonly customer: Customer

Accessors

Type: Customer

Modifiers: readonly

Since: 24.2

deputy​

readonly deputy: User

Accessors

Type: User

Modifiers: readonly

Since: 24.2

description​

description: string

description

Type: string

Since: 24.2

monitorLevel​

monitorLevel: MonitorLevel

monitor level

Type: MonitorLevel

Since: 24.2

monitoring​

monitoring: boolean

monitoring

Type: boolean

Since: 24.2

monitoringOffReasons​

monitoringOffReasons: MonitoringOffReason[]

monitoring off reasons

Type: MonitoringOffReason[]

Since: 24.2

name​

name: string

name

Type: string

Since: 24.2

operationalSince​

operationalSince: Date

operational since

Type: Date

Since: 24.2

operationalUntil​

operationalUntil: Date

operational until

Type: Date

Since: 24.2

sla​

readonly sla: SLA

Accessors

Type: SLA

Modifiers: readonly

Since: 25.1

systemId​

systemId: any

system id

Type: any

Since: 24.2

systemRoleName​

readonly systemRoleName: string

Accessors

Type: string

Modifiers: readonly

Since: 24.2

systemType​

systemType: SystemType

system type

Type: SystemType

Since: 24.2

timestamp​

timestamp: Date

timestamp

Type: Date

Since: 24.2

timezone​

timezone: string

timezone

Type: string

Since: 24.2

uuid​

uuid: string

unique id

Type: string

Since: 24.2

Class NamespaceChangeOption​

namespace change option

modifiable​

modifiable: Modifiable

modifiable

Type: Modifiable

Since: 24.2

namespace​

namespace: string

namesapce

Type: string

Since: 24.2

prefix​

prefix: string

prefix

Type: string

Since: 24.2

Class NamespaceChecks​

createExternalCheck​

createExternalCheck(name: string): ExternalCheck

Since: 24.2

Parameters

  • name (string) - name of external check

Returns: ExternalCheck - instance of new external check

getById​

getById(checkId: any): Check

Since: 24.2

Parameters

  • checkId (any) - check id

Returns: Check - a check (rtm or daily, if id has both rtm check is returned)

getById​

getById(checkId: any, rtmFirst: boolean): Check

Since: 24.2

Parameters

  • checkId (any) - check id
  • rtmFirst (boolean) - Only if check is a rtm and daily check, true returns the rtm check and false return the daily check

Returns: Check - a check (rtm or daily)

getByName​

getByName(name: string): Check[]

Since: 24.2

Parameters

  • name (string) - name of built-in or custom check

Returns: Check[] - list of all checks having the name

getByName​

getByName(name: string, status: Status): Check[]

Since: 24.2

Parameters

  • name (string) - name of built-in or custom check
  • status (Status) - filter checks by status

Returns: Check[] - list of checks

Class NamespaceCredentials​

decrypt​

decrypt(s: string): string

Decrypts the given string

Since: 25.1

Parameters

  • s (string) - the string to decrypt

Returns: string - the decrypted string, or null if decryption failed

decryptList​

decryptList(s: string): any[]

Decrypts the given string containing an encrypted list

Since: 25.1

Parameters

  • s (string) - the encrypted list

Returns: any[] - the decrypted list of objects, or null if decryption failed

getSharedCredential​

getSharedCredential(name: string): CredentialProxy

Return shared credential with given name, or null if it does not exist

Since: 25.1

Parameters

  • name (string) - shared credential name

Returns: CredentialProxy - a credential

getSystemCredential​

getSystemCredential(ms: MonitoredSystem, key: string): CredentialProxy

Since: 25.1

Parameters

  • ms (MonitoredSystem) - the monitored system
  • key (string) - credential key

Returns: CredentialProxy - system credential with given key assigned to that system, or null, if it does not exist

Class NamespaceDatabases​

all​

all(): Database[]

Since: 24.2

Returns: Database[] - a list of all databases

getById​

getById(systemId: any): Database

Since: 24.2

Parameters

  • systemId (any) - system id

Returns: Database - a database

getByName​

getByName(name: string): Database

Since: 24.2

Parameters

  • name (string) - database name

Returns: Database - a database

Class NamespaceSAPNotes​

computeAndStoreRelevantSAPNotes​

computeAndStoreRelevantSAPNotes(noteIds: any, systemIds: any): RelevantSAPNotesResult

Calculates relevant hot news for SAP systems. Only notes of type 'H' and 'S' are considered.

Since: 25.2

Parameters

  • noteIds (any) - List of Note IDs. If null, all notes will be calculated.
  • systemIds (any) - List of System IDs. If null, all systems will be calculated.

Returns: RelevantSAPNotesResult - RelevantSAPNotesResult Result of the computation.

computeAndStoreRelevantSAPNotes​

computeAndStoreRelevantSAPNotes(noteIds: any, systemIds: any, types: any): RelevantSAPNotesResult

Calculates relevant hot news for SAP systems

Since: 25.2

Parameters

  • noteIds (any) - List of Note IDs. If null, all notes will be calculated.
  • systemIds (any) - List of System IDs. If null, all systems will be calculated.
  • types (any) - List of Note Types (e.g., "H", "I", "S"). If null, all types will be calculated.

Returns: RelevantSAPNotesResult - RelevantSAPNotesResult Result of the computation.

Class NamespaceSapInstances​

all​

all(): SapInstance[]

Since: 24.2

Returns: SapInstance[] - a list of all sap instances

getById​

getById(systemId: any): SapInstance

Since: 24.2

Parameters

  • systemId (any) - system id

Returns: SapInstance - a sap instance

getByName​

getByName(name: string): SapInstance

Since: 24.2

Parameters

  • name (string) - sap instance name

Returns: SapInstance - a sap instance

Class NamespaceSapsystems​

all​

all(): SapSystem[]

Since: 24.2

Returns: SapSystem[] - a list of all sap systems

getById​

getById(systemId: any): SapSystem

Since: 24.2

Parameters

  • systemId (any) - system id

Returns: SapSystem - a sap system

getByName​

getByName(name: string): SapSystem

Since: 24.2

Parameters

  • name (string) - sap system name

Returns: SapSystem - a sap system

getByUnifiedSapSid​

getByUnifiedSapSid(unifiedSapSid: string): SapSystem

Since: 24.2

Parameters

  • unifiedSapSid (string) - unified sap sid

Returns: SapSystem - a sap system

Class NamespaceServers​

all​

all(): Server[]

Since: 24.2

Returns: Server[] - a list of all servers

getById​

getById(systemId: any): Server

Since: 24.2

Parameters

  • systemId (any) - No description.

Returns: Server - a server

getByName​

getByName(name: string): Server

Since: 24.2

Parameters

  • name (string) - server name

Returns: Server - a server

Class NamespaceSystems​

all​

all(): MonitoredSystem[]

Since: 24.2

Returns: MonitoredSystem[] - a list of all systems

findFirstSystemSelectorsByName​

findFirstSystemSelectorsByName(name: any): SystemSelector

Find the first system selectors with a name. NOTE: this call only finds non-ad-hoc system selectors.

Since: 24.2

Parameters

  • name (any) - No description.

Returns: SystemSelector - the first system selector with the given name or null if there is no such system selector.

findSystemSelectorsByName​

findSystemSelectorsByName(name: any): SystemSelector[]

Find all system selectors with a name. NOTE: this call only finds non-ad-hoc system selectors.

Since: 24.2

Parameters

  • name (any) - No description.

Returns: SystemSelector[] - the list system selectors with the given name or an empty list if there is no such system selector.

getById​

getById(systemId: any): MonitoredSystem

Since: 24.2

Parameters

  • systemId (any) - No description.

Returns: MonitoredSystem - a system

getSystemSelectorById​

getSystemSelectorById(id: any): SystemSelector

Find a system selector by its id.

Since: 24.2

Parameters

  • id (any) - No description.

Returns: SystemSelector - the system selector or null if it can not be found.

databases​

readonly databases: NamespaceDatabases

Namespace: databases

Type: NamespaceDatabases

Modifiers: readonly

Since: 24.2

sapinstances​

readonly sapinstances: NamespaceSapInstances

Namespace: sapinstances

Type: NamespaceSapInstances

Modifiers: readonly

Since: 24.2

sapsystems​

readonly sapsystems: NamespaceSapsystems

Namespace: sapsystems

Type: NamespaceSapsystems

Modifiers: readonly

Since: 24.2

servers​

readonly servers: NamespaceServers

Namespace: servers

Type: NamespaceServers

Modifiers: readonly

Since: 24.2

Class OAuthAuthorizationCodeProfileCredential​

OAuthAuthorizationCodeProfile credential object, provides access to credential details

accessToken​

accessToken: string

Type: string

Since: 25.1

accessTokenUri​

accessTokenUri: string

Type: string

Since: 25.1

authorizationUri​

authorizationUri: string

Type: string

Since: 25.1

clientId​

clientId: string

Type: string

Since: 25.1

clientSecret​

clientSecret: string

Type: string

Since: 25.1

expirationDateInMillis​

expirationDateInMillis: number

Type: number

Since: 25.1

name​

name: string

Type: string

Since: 25.1

redirectUri​

redirectUri: string

Type: string

Since: 25.1

refreshToken​

refreshToken: string

Type: string

Since: 25.1

scope​

scope: string

Type: string

Since: 25.1

Class OAuthClientCredentialsProfileCredential​

OAuthClientCredentialsProfile credential object, provides access to credential details

accessToken​

accessToken: string

Type: string

Since: 25.1

accessTokenUri​

accessTokenUri: string

Type: string

Since: 25.1

clientId​

clientId: string

Type: string

Since: 25.1

clientSecret​

clientSecret: string

Type: string

Since: 25.1

name​

name: string

Type: string

Since: 25.1

scope​

scope: string

Type: string

Since: 25.1

Class ProductVersion​

product version

product​

product: string

product

Type: string

Since: 24.2

release​

release: string

release

Type: string

Since: 24.2

shortDescription​

shortDescription: string

short description

Type: string

Since: 24.2

spStack​

spStack: string

sp stack

Type: string

Since: 24.2

status​

status: ProductVersionStatus

status

Type: ProductVersionStatus

Since: 24.2

Class RFCCredential​

RFC authentication credential object, provides access to credential details

client​

client: string

client

Type: string

Since: 25.1

password​

password: string

password

Type: string

Since: 25.1

username​

username: string

username

Type: string

Since: 25.1

Class RelevantSAPNotesResult​

Result object of the computation of relevant SAP Notes for systems.

calculatedNotes​

calculatedNotes: number

Number of calculated notes in the computation

Type: number

Since: 25.2

computationTimeMs​

computationTimeMs: number

Time taken for the computation in milliseconds

Type: number

Since: 25.2

insertCount​

insertCount: number

Number of inserted note implementations

Type: number

Since: 25.2

message​

message: string

Message in case of an error

Type: string

Since: 25.2

noteToSystemsMap​

noteToSystemsMap: Map<Integer,List<Integer>>

Map of SAP Note database ID to list of system IDs the note is relevant for

Type: Map<Integer,List<Integer>>

Since: 25.2

sapSystems​

sapSystems: number

Number of SAP systems considered in the computation

Type: number

Since: 25.2

success​

success: boolean

Indicates whether the computation was successful or not

Type: boolean

Since: 25.2

updateCount​

updateCount: number

Number of updated note implementations

Type: number

Since: 25.2

Class SAPCONTROLAuthenticationCredential​

SAP Control authentication credential object, provides access to credential details

certChain​

certChain: string

Type: string

Since: 25.1

name​

name: string

Type: string

Since: 25.1

passphrase​

passphrase: string

Type: string

Since: 25.1

password​

password: string

Type: string

Since: 25.1

pk​

pk: string

Type: string

Since: 25.1

username​

username: string

Type: string

Since: 25.1

Class SAPHostCONTROLAuthenticationCredential​

SAP Host Control authentication credential object, provides access to credential details

certChain​

certChain: string

Type: string

Since: 25.1

name​

name: string

Type: string

Since: 25.1

passphrase​

passphrase: string

Type: string

Since: 25.1

password​

password: string

Type: string

Since: 25.1

pk​

pk: string

Type: string

Since: 25.1

username​

username: string

Type: string

Since: 25.1

Class SLA​

sla (service level agreement)

availabilityRate​

availabilityRate: number

Committed availability rate for this SLR. The value is between 0 and 1, where 1 is equivalent to 100% availability.

Type: number

Since: 25.1

description​

description: string

description

Type: string

Since: 25.1

name​

name: string

name

Type: string

Since: 25.1

slaId​

slaId: number

sla id

Type: number

Since: 25.1

timestamp​

timestamp: Date

timestamp

Type: Date

Since: 25.1

timezone​

timezone: string

timezone

Type: string

Since: 25.1

utc​

utc: boolean

true if this sla is in UTC timezone, otherwise false

Type: boolean

Since: 25.1

Class SSHCredential​

SSH credential object, provides access to credential details

hostName​

hostName: string

Type: string

Since: 25.1

passphrase​

passphrase: string

Type: string

Since: 25.1

password​

password: string

Type: string

Since: 25.1

rsaPrivateKey​

rsaPrivateKey: string

Type: string

Since: 25.1

sshPort​

sshPort: number

Type: number

Since: 25.1

timeoutInMillis​

timeoutInMillis: number

Type: number

Since: 25.1

userName​

userName: string

Type: string

Since: 25.1

Class SapBusinessObject​

sap business object

baseUrl​

baseUrl: string

base url

Type: string

Since: 24.2

windowsServiceName​

windowsServiceName: string

windows service name

Type: string

Since: 24.2

Class SapClient​

sap client

changeDate​

changeDate: Date

change date

Type: Date

Since: 24.2

changesAndTransportsForClientSpecificObjects​

changesAndTransportsForClientSpecificObjects: number

change and transports for client specific objects

Type: number

Since: 24.2

client​

client: string

client

Type: string

Since: 24.2

currency​

currency: string

currency

Type: string

Since: 24.2

lastChangedBy​

lastChangedBy: string

last change by

Type: string

Since: 24.2

location​

location: string

location

Type: string

Since: 24.2

logicalSystem​

logicalSystem: string

logical system

Type: string

Since: 24.2

maintenanceAuthorizationForAllObjectsInAllClients​

maintenanceAuthorizationForAllObjectsInAllClients: number

maintenance authorization for all objects in all clients

Type: number

Since: 24.2

name​

name: string

name

Type: string

Since: 24.2

role​

role: string

role

Type: string

Since: 24.2

Class SapInstance​

getSapSystem​

getSapSystem(): SapSystem

Since: 24.2

Returns: SapSystem - sap system of instance

See Also: sapSystem

getServer​

getServer(): Server

server of instance

Since: 24.2

See Also: server

central​

central: boolean

is central instance

Type: boolean

Since: 24.2

instanceProfile​

instanceProfile: string

instance profile

Type: string

Since: 24.2

instanceType​

instanceType: string

instance type

Type: string

Since: 24.2

j2eeKernelPatchLevel​

j2eeKernelPatchLevel: string

j2ee kernel patch level

Type: string

Since: 24.2

j2eeKernelRelease​

j2eeKernelRelease: string

j2ee kernel release

Type: string

Since: 24.2

kernelMakeVariant​

kernelMakeVariant: string

kernel make variant

Type: string

Since: 24.2

kernelPatchLevel​

kernelPatchLevel: number

kernel patch level

Type: number

Since: 24.2

kernelRelease​

kernelRelease: string

kernel release

Type: string

Since: 24.2

lastSeen​

lastSeen: Date

last seen

Type: Date

Since: 24.2

sapSystem​

readonly sapSystem: SapSystem

Accessors

Type: SapSystem

Modifiers: readonly

Since: 24.2

server​

readonly server: Server

server of instance

Accessors

Type: Server

Modifiers: readonly

Since: 24.2

systemNumber​

systemNumber: string

system number

Type: string

Since: 24.2

Class SapLicenseBase​

base class for sap license

hardwareKey​

hardwareKey: string

hardware key

Type: string

Since: 24.2

installation​

installation: string

installation

Type: string

Since: 24.2

sid​

sid: string

sid

Type: string

Since: 24.2

softwareProduct​

softwareProduct: string

software product

Type: string

Since: 24.2

userLimit​

userLimit: number

user limit

Type: number

Since: 24.2

validFrom​

validFrom: Date

valid from

Type: Date

Since: 24.2

validUntil​

validUntil: Date

valid until

Type: Date

Since: 24.2

Class SapNoteImplementation​

sap note

component​

component: string

component

Type: string

Since: 24.2

id​

id: number

id

Type: number

Since: 24.2

implementationDate​

implementationDate: Date

implementation date

Type: Date

Since: 24.2

implementationStatus​

implementationStatus: NoteImplementationStatus

implementation status

Type: NoteImplementationStatus

Since: 24.2

implementationUser​

implementationUser: string

implementation user

Type: string

Since: 24.2

message​

message: string

message

Type: string

Since: 24.2

priority​

priority: number

priority

Type: number

Since: 24.2

status​

status: NoteStatus

note status

Type: NoteStatus

Since: 24.2

text​

text: string

text

Type: string

Since: 24.2

version​

version: number

version

Type: number

Since: 24.2

Class SapSystem​

sap system

getAbapSoftwareComponents​

getAbapSoftwareComponents(): AbapSoftwareComponent[]

Since: 24.2

Returns: AbapSoftwareComponent[] - a list of all abap components

See Also: abapSoftwareComponents

getClients​

getClients(): SapClient[]

Since: 24.2

Returns: SapClient[] - a list of all clients

See Also: clients

getCustomer​

getCustomer(): Customer

Since: 24.2

Returns: Customer - customer

See Also: customer

getDatabase​

getDatabase(): Database

Since: 24.2

Returns: Database - the sap systems database

See Also: database

getDatabaseMonitoringServer​

getDatabaseMonitoringServer(): Server

Since: 24.2

Returns: Server - database monitoring server

See Also: databaseMonitoringServer

getInstances​

getInstances(): SapInstance[]

Since: 24.2

Returns: SapInstance[] - a list of all sap instances

See Also: instances

getJ2eeSoftwareComponents​

getJ2eeSoftwareComponents(): J2eeSoftwareComponent[]

Since: 24.2

Returns: J2eeSoftwareComponent[] - a list of all j2ee components

See Also: J2eeSoftwareComponents

getNamespaceChangeOptions​

getNamespaceChangeOptions(): NamespaceChangeOption[]

Since: 24.2

Returns: NamespaceChangeOption[] - a list of all namespace change options

See Also: namespaceChangeOptions

getRemoteMonitoringServer​

getRemoteMonitoringServer(): Server

Since: 24.2

Returns: Server - remote monitoring server

See Also: remoteMonitoringServer

getSapLicenses​

getSapLicenses(): SapLicenseBase[]

Since: 24.2

Returns: SapLicenseBase[] - a list of all licenses

See Also: sapLicenses

getSapNotes​

getSapNotes(onlyNewest: boolean): SapNoteImplementation[]

Since: 24.2

Parameters

  • onlyNewest (boolean) - No description.

Returns: SapNoteImplementation[] - a list of all sap notes

getSoftwareChangeOptions​

getSoftwareChangeOptions(): SoftwareChangeOption[]

Since: 24.2

Returns: SoftwareChangeOption[] - a list of all software change options

See Also: softwareChangeOptions

getSolutionManager​

getSolutionManager(): SapSystem

Since: 24.2

Returns: SapSystem - the solution manager

See Also: solutionManager

getSolutionManagerConnectedSystems​

getSolutionManagerConnectedSystems(): SapSystem[]

Since: 24.2

Returns: SapSystem[] - a list of all systems connected from solution manager

See Also: solutionManagerConnectedSystems

J2eeSoftwareComponents​

readonly J2eeSoftwareComponents: J2eeSoftwareComponent[]

Accessors

Type: J2eeSoftwareComponent[]

Modifiers: readonly

Since: 24.2

abapSoftwareComponents​

readonly abapSoftwareComponents: AbapSoftwareComponent[]

Accessors

Type: AbapSoftwareComponent[]

Modifiers: readonly

Since: 24.2

agentlessRemote​

agentlessRemote: boolean

agentless remote

Type: boolean

Since: 24.2

avantraTransportVersion​

avantraTransportVersion: string

Avantra transport version

Type: string

Since: 24.2

avantraTransports​

avantraTransports: AvantraTransport[]

Avantra transports

Type: AvantraTransport[]

Since: 24.2

basisRelease​

basisRelease: string

basis release

Type: string

Since: 24.2

clients​

readonly clients: SapClient[]

Accessors

Type: SapClient[]

Modifiers: readonly

Since: 24.2

customer​

readonly customer: Customer

Accessors

Type: Customer

Modifiers: readonly

Since: 24.2

database​

readonly database: Database

Accessors

Type: Database

Modifiers: readonly

Since: 24.2

databaseColumnStore​

databaseColumnStore: boolean

database column store

Type: boolean

Since: 24.2

databaseFullRelease​

databaseFullRelease: string

database full release

Type: string

Since: 24.2

databaseHost​

databaseHost: string

database port

Type: string

Since: 24.2

databaseMonitoringServer​

readonly databaseMonitoringServer: Server

Accessors

Type: Server

Modifiers: readonly

Since: 24.2

databaseName​

databaseName: string

database name

Type: string

Since: 24.2

databasePort​

databasePort: number

database port

Type: number

Since: 24.2

databasePreventAutomaticUpdate​

databasePreventAutomaticUpdate: boolean

prevent automatic updates for database

Type: boolean

Since: 24.2

databaseRelease​

databaseRelease: string

database release

Type: string

Since: 24.2

databaseType​

databaseType: string

database type

Type: string

Since: 24.2

encoding​

encoding: string

encoding

Type: string

Since: 24.2

instances​

readonly instances: SapInstance[]

Accessors

Type: SapInstance[]

Modifiers: readonly

Since: 24.2

lastVersionScan​

lastVersionScan: Date

last version scan

Type: Date

Since: 24.2

namespaceChangeOptions​

readonly namespaceChangeOptions: NamespaceChangeOption[]

Accessors

Type: NamespaceChangeOption[]

Modifiers: readonly

Since: 24.2

notes​

notes: string

notes

Type: string

Since: 24.2

offlineBackupInfo​

offlineBackupInfo: string

offline backup info

Type: string

Since: 24.2

offlineBackupStart​

offlineBackupStart: Date

offline backup start

Type: Date

Since: 24.2

offlineBackupState​

offlineBackupState: OfflineBackupState

offline backup state

Type: OfflineBackupState

Since: 24.2

productVersions​

productVersions: ProductVersion[]

product versions

Type: ProductVersion[]

Since: 24.2

realSapSid​

realSapSid: string

sap sid

Type: string

Since: 24.2

remoteMonitoringEntryPoint​

remoteMonitoringEntryPoint: string

remote monitoring entry point

Type: string

Since: 24.2

remoteMonitoringServer​

readonly remoteMonitoringServer: Server

Accessors

Type: Server

Modifiers: readonly

Since: 24.2

s4HType​

s4HType: S4HType

S4H type

Type: S4HType

Since: 24.2

sapLicenses​

readonly sapLicenses: SapLicenseBase[]

Accessors

Type: SapLicenseBase[]

Modifiers: readonly

Since: 24.2

softwareChangeOptions​

readonly softwareChangeOptions: SoftwareChangeOption[]

Accessors

Type: SoftwareChangeOption[]

Modifiers: readonly

Since: 24.2

solutionManager​

readonly solutionManager: SapSystem

Accessors

Type: SapSystem

Modifiers: readonly

Since: 24.2

solutionManagerConnectedSystems​

readonly solutionManagerConnectedSystems: SapSystem[]

Accessors

Type: SapSystem[]

Modifiers: readonly

Since: 24.2

spamPatchLevel​

spamPatchLevel: string

spam patch level

Type: string

Since: 24.2

unifiedSapSid​

unifiedSapSid: string

unified sap sid

Type: string

Since: 24.2

Class Server​

server

canOsExec​

canOsExec(): boolean

Since: 25.1

Returns: boolean - true if operation system commands can be executed on that server, otherwise false

getDatabases​

getDatabases(): Database[]

Since: 24.2

Returns: Database[] - a list of databases on this server

See Also: databases

getDnsDomain​

getDnsDomain(): DnsDomain

Since: 24.2

Returns: DnsDomain - dns domain

See Also: dnsDomain

getInstances​

getInstances(): SapInstance[]

Since: 24.2

Returns: SapInstance[] - a list of sap instances on this server

See Also: instances

agentVersion​

agentVersion: string

agent version

Type: string

Since: 24.2

cloudInfo​

cloudInfo: CloudInfo

cloud info

Type: CloudInfo

Since: 24.3

cpuInfo​

cpuInfo: CpuInfo

cpu info

Type: CpuInfo

Since: 24.3

databases​

readonly databases: Database[]

Accessors

Type: Database[]

Modifiers: readonly

Since: 24.2

dnsAliases​

dnsAliases: string[]

dns aliases

Type: string[]

Since: 24.2

dnsDomain​

readonly dnsDomain: DnsDomain

Accessors

Type: DnsDomain

Modifiers: readonly

Since: 24.2

gateway​

gateway: boolean

is gateway

Type: boolean

Since: 24.2

instances​

readonly instances: SapInstance[]

Accessors

Type: SapInstance[]

Modifiers: readonly

Since: 24.2

ipAddress​

ipAddress: string

ip address

Type: string

Since: 24.2

natTraversal​

natTraversal: boolean

is nat traversal

Type: boolean

Since: 24.2

osArchitecture​

osArchitecture: OsArchitecture

os architecture

Type: OsArchitecture

Since: 24.2

osLongName​

osLongName: string

os long name

Type: string

Since: 24.3

osName​

osName: string

os name

Type: string

Since: 24.3

osPlatform​

osPlatform: string

os platform

Type: string

Since: 24.3

osType​

osType: string

os type

Type: string

Since: 24.3

osVersion​

osVersion: string

os version

Type: string

Since: 24.3

physicalMemory​

physicalMemory: number

physical memory

Type: number

Since: 24.3

project​

project: string

project

Type: string

Since: 24.2

region​

region: string

region

Type: string

Since: 24.2

serialNumber​

serialNumber: string

serial number

Type: string

Since: 24.2

virtualClusterServer​

virtualClusterServer: boolean

is virtual cluster server

Type: boolean

Since: 24.2

zone​

zone: string

zone

Type: string

Since: 24.2

Class SoftwareChangeOption​

software change option

component​

component: string

component

Type: string

Since: 24.2

modifiable​

modifiable: Modifiable

modifiable

Type: Modifiable

Since: 24.2

Class Status​

status

Enum DISABLED​

disabled

Declared on Status.

Enum UNKNOWN​

unknown

Declared on Status.

Enum OK​

ok

Declared on Status.

Enum WARNING​

warning

Declared on Status.

Enum CRITICAL​

critical

Declared on Status.

getId​

getId(): number

Since: 24.2

Returns: number - status id

See Also: id

id​

readonly id: number

Accessors

Type: number

Modifiers: readonly

Since: 24.2

Class SystemSelector​

system selector

getCustomer​

getCustomer(): Customer

Since: 24.2

Returns: Customer - customer

See Also: customer

getDescription​

getDescription(): string

Since: 24.2

Returns: string - description

See Also: description

getId​

getId(): number

Since: 24.2

Returns: number - selector id

See Also: id

getName​

getName(): string

Since: 24.2

Returns: string - selector name

See Also: name

getType​

getType(): SelectorObjectType

product version

Since: 24.2

See Also: type

list​

list(): MonitoredSystem[]

evaluate system selector

Since: 24.2

Returns: MonitoredSystem[] - system list

customer​

readonly customer: Customer

Accessors

Type: Customer

Modifiers: readonly

Since: 24.2

description​

readonly description: string

Accessors

Type: string

Modifiers: readonly

Since: 24.2

id​

readonly id: number

Accessors

Type: number

Modifiers: readonly

Since: 24.2

name​

readonly name: string

Accessors

Type: string

Modifiers: readonly

Since: 24.2

type​

readonly type: SelectorObjectType

product version

Accessors

Type: SelectorObjectType

Modifiers: readonly

Since: 24.2

Class User​

user

address​

address: string

address

Type: string

Since: 24.2

city​

city: string

city

Type: string

Since: 24.2

countryCode​

countryCode: string

country

Type: string

Since: 24.2

customData​

customData: object

custom data

Type: object

Since: 24.2

description​

description: string

description

Type: string

Since: 24.2

email​

email: string

email

Type: string

Since: 24.2

emailAlt​

emailAlt: string

alternative email

Type: string

Since: 24.2

fax​

fax: string

fax number

Type: string

Since: 24.2

firstName​

firstName: string

first name

Type: string

Since: 24.2

fixPhone​

fixPhone: string

phone number

Type: string

Since: 24.2

lastName​

lastName: string

last name

Type: string

Since: 24.2

locked​

locked: boolean

is locked

Type: boolean

Since: 24.2

mobilePhone​

mobilePhone: string

mobile phone number

Type: string

Since: 24.2

poBox​

poBox: string

po box

Type: string

Since: 24.2

postalCode​

postalCode: string

postal code

Type: string

Since: 24.2

principal​

principal: string

principal

Type: string

Since: 24.2

timestamp​

timestamp: Date

timestamp

Type: Date

Since: 24.2

timezone​

timezone: string

timezone

Type: string

Since: 24.2

title​

title: string

title

Type: string

Since: 24.2

userId​

userId: number

user id

Type: number

Since: 24.2

validFrom​

validFrom: Date

valid from

Type: Date

Since: 24.2

validUntil​

validUntil: Date

valid until

Type: Date

Since: 24.2

Class VmWareCloudInfo​

VMware cloud info

cluster​

cluster: string

cluster

Type: string

Since: 24.3

dataCenter​

dataCenter: string

data center

Type: string

Since: 24.3

host​

host: string

host

Type: string

Since: 24.3

ipAddress​

ipAddress: string

ip address

Type: string

Since: 24.3

macAddresses​

macAddresses: string

mac addresses

Type: string

Since: 24.3

powerState​

powerState: VmWarePowerState

power state

Type: VmWarePowerState

Since: 24.3

toolInstallationType​

toolInstallationType: string

tool installation type

Type: string

Since: 24.3

toolRunningStatus​

toolRunningStatus: string

tool running status

Type: string

Since: 24.3

toolVersion​

toolVersion: string

tool version

Type: string

Since: 24.3

toolVersionStatus​

toolVersionStatus: string

tool version status

Type: string

Since: 24.3