Skip to main content

# Server

No description

    type Server implements MonitoredSystem {
      id: ID!
      mst: Int!
      checks(
        where: FilterInput
        order: OrderInput
      ): [Check!]!
      checkCount(
        where: FilterInput
      ): Int!
      checkCountSummary(
        filter: CheckKind
      ): CheckCountSummary!
      checksRelay(
        first: Int
        after: String
        where: FilterInput
        order: OrderInput
      ): CheckConnection
      customAttributes: [CustomAttribute!]!
      customData: String
      customer: Customer!
      description: String
      maintenance: Boolean
      monitorOff: Boolean
      monitorOffUntil: DateTime
      monitorSwitchReason: String
      monitorSwitchDate: DateTime
      name: String
      operational: Boolean
      operationalSince: Date
      operationalUntil: Date
      status: Status!
      statusId: Int!
      systemRole: String @deprecated
      role: SystemRole
      type: MonitoredSystemType!
      timestamp: DateTime
      uuid: String
      ipAddress: String!
      dnsAliases: [String!]!
      dnsDomain: String
      domain: DnsDomain
      physicalMemory: Float
      filesystemTotalSize: Float
      filesystemTotalUsed: Float
      sapHardwareKey: String
      osType: String
      osPlatform: String
      osName: String
      osLongName: String
      osVersion: String
      osArchitecture: String
      notes: String
      virtualClusterServer: Boolean!
      aliveStatus: AliveStatus!
      aliveLastUpdate: DateTime
      aliveSince: DateTime
      javaDetails: ServerJavaInfo
      javaInfo: String @deprecated
      cpuDetails: ServerCpuInfo
      cpuInfo: String @deprecated
      cloudDetails: ServerCloudInfo
      cloudInfo: String @deprecated
      region: String
      zone: String
      project: String
      gateway: Boolean
      natTraversal: Boolean
      publicKey: String
      applicationType: String
      rtmStatus: Status
      rtmDate: DateTime
      timezone: String
      nodeOf: [Server!]!
      nodes: [Server!]!
      activeNode: Server
      sapInstances: [SapInstance!]!
      sapInstanceCount: Int!
      sapSystems: [SapSystem!]!
      sapSystemCount: Int!
      cloudServices: [CloudService!]!
      cloudServiceCount: Int!
      businessObjects: [SapBusinessObject!]!
      businessObjectCount: Int!
      databases: [Database!]!
      databaseCount: Int!
      actions(
        actionType: [SystemActionType!] = [Start, Stop, Restart]
      ): [SystemAction!]!
      performance: MonitoredSystemPerformanceData
      agentVersion: String
      administrator: User
      administratorDeputy: User
      remote: Boolean!
      info: [InfoNode]
      assignedSLA: ServiceLevelAgreement
      cloudServiceAuthentication: CloudServiceAuthentication
      monitorLevel: MonitorLevel!
      credentialPurposes: [CredentialsPurpose]!
      credentials: [CredentialsBase]!
      notSeen: Boolean
      notifications(
        where: FilterInput
        order: OrderInput
      ): [Notification]!
      pagedNotifications(
        pageRequest: PageRequest!
        where: FilterInput
        order: OrderInput
      ): NotificationPage!
      serialNumber: String
      managedStatus: ManagedSystemStatus!
      virtualServerConfiguration: VirtualServerConfiguration
      monitoringParametersGroups: [MonitoringParameterGroup!]!
      monitoringParameterByName(
        name: String!
      ): ValueParameter
      draft: Boolean!
      application: ApplicationType
      changes(
        where: FilterInput
        order: OrderInput
      ): [Change!]!
      pagedChanges(
        pageRequest: PageRequest!
        where: FilterInput
        order: OrderInput
      ): ChangePage
      systemParameterSets: [SystemParameterSet!]!
    }

### Fields​

#### `Server.id` ● `ID!` non-null scalar​

#### `Server.mst` ● `Int!` non-null scalar​

The numeric monitored system type. 0 = Server 1 = SapInstance 2 = SapSystem 3 = Database (can be StandaloneDatabase or SapSystemDatabase) (4 = BusinessService) 5 = SapBusinessObject 6 = CloudService

#### `Server.checks` ● `[Check!]!` non-null interface​

Get all the available RTM checks for the given status selection. If the call should return different kind of checks the filter input has to be used with the explicit value for the kind field. If there is no kind filter field defined it defaults to: { name: "kind" operator: eq value: "RTM" }

##### `Server.checks.where` ● `FilterInput` input​

The filter conditions for this query.

##### `Server.checks.order` ● `OrderInput` input​

The order of the results.

#### `Server.checkCount` ● `Int!` non-null scalar​

Count the affected checks.

##### `Server.checkCount.where` ● `FilterInput` input​

The filter conditions for this query.

#### `Server.checkCountSummary` ● `CheckCountSummary!` non-null object​

Get a check count summary.

##### `Server.checkCountSummary.filter` ● `CheckKind` enum​

#### `Server.checksRelay` ● `CheckConnection` object​

##### `Server.checksRelay.first` ● `Int` scalar​

##### `Server.checksRelay.after` ● `String` scalar​

##### `Server.checksRelay.where` ● `FilterInput` input​

##### `Server.checksRelay.order` ● `OrderInput` input​

#### `Server.customAttributes` ● `[CustomAttribute!]!` non-null object​

Custom attributes defined for this monitored system.

#### `Server.customData` ● `String` scalar​

Special data for this monitored system

#### `Server.customer` ● `Customer!` non-null object​

#### `Server.description` ● `String` scalar​

#### `Server.maintenance` ● `Boolean` scalar​

#### `Server.monitorOff` ● `Boolean` scalar​

#### `Server.monitorOffUntil` ● `DateTime` scalar​

#### `Server.monitorSwitchReason` ● `String` scalar​

#### `Server.monitorSwitchDate` ● `DateTime` scalar​

#### `Server.name` ● `String` scalar​

#### `Server.operational` ● `Boolean` scalar​

#### `Server.operationalSince` ● `Date` scalar​

#### `Server.operationalUntil` ● `Date` scalar​

#### `Server.status` ● `Status!` non-null enum​

The status of the monitored system

#### `Server.statusId` ● `Int!` non-null scalar​

The check status as number: 2 => CRITICAL 1 => WARNING 0 => OK -1 => UNKNOWN -2 => DISABLED

#### `Server.systemRole` ● `String` deprecated scalar​

DEPRECATED

Use the improved variant role that points to a SystemRole type.

The role of this system.

#### `Server.role` ● `SystemRole` object​

The role of this system.

#### `Server.type` ● `MonitoredSystemType!` non-null enum​

#### `Server.timestamp` ● `DateTime` scalar​

#### `Server.uuid` ● `String` scalar​

#### `Server.ipAddress` ● `String!` non-null scalar​

The ip address of this server.

#### `Server.dnsAliases` ● `[String!]!` non-null scalar​

#### `Server.dnsDomain` ● `String` scalar​

#### `Server.domain` ● `DnsDomain` object​

The DNS domain object for this server - can be null.

#### `Server.physicalMemory` ● `Float` scalar​

#### `Server.filesystemTotalSize` ● `Float` scalar​

#### `Server.filesystemTotalUsed` ● `Float` scalar​

#### `Server.sapHardwareKey` ● `String` scalar​

#### `Server.osType` ● `String` scalar​

#### `Server.osPlatform` ● `String` scalar​

#### `Server.osName` ● `String` scalar​

#### `Server.osLongName` ● `String` scalar​

#### `Server.osVersion` ● `String` scalar​

#### `Server.osArchitecture` ● `String` scalar​

#### `Server.notes` ● `String` scalar​

#### `Server.virtualClusterServer` ● `Boolean!` non-null scalar​

True if this is a virtual cluster server

#### `Server.aliveStatus` ● `AliveStatus!` non-null enum​

#### `Server.aliveLastUpdate` ● `DateTime` scalar​

#### `Server.aliveSince` ● `DateTime` scalar​

#### `Server.javaDetails` ● `ServerJavaInfo` object​

#### `Server.javaInfo` ● `String` deprecated scalar​

DEPRECATED

Kept for backward compatibility with the mobile app. There is a typed alternative: javaDetails

#### `Server.cpuDetails` ● `ServerCpuInfo` object​

#### `Server.cpuInfo` ● `String` deprecated scalar​

DEPRECATED

Kept for backward compatibility with the mobile app. There is a typed alternative: cpuDetails

#### `Server.cloudDetails` ● `ServerCloudInfo` interface​

#### `Server.cloudInfo` ● `String` deprecated scalar​

DEPRECATED

Kept for backward compatibility with the mobile app. There is a typed alternative: cloudDetails

#### `Server.region` ● `String` scalar​

The cloud region. The value depends on cloud provider.

#### `Server.zone` ● `String` scalar​

The cloud zone. The value depends on cloud provider

#### `Server.project` ● `String` scalar​

The cloud project. The value depends on cloud provider

#### `Server.gateway` ● `Boolean` scalar​

Is this server a gateway (null = false).

#### `Server.natTraversal` ● `Boolean` scalar​

Does this server implement NAT traversal.

#### `Server.publicKey` ● `String` scalar​

#### `Server.applicationType` ● `String` scalar​

The application type of this monitored system.

#### `Server.rtmStatus` ● `Status` enum​

#### `Server.rtmDate` ● `DateTime` scalar​

#### `Server.timezone` ● `String` scalar​

The time zone of this server.

#### `Server.nodeOf` ● `[Server!]!` non-null object​

The list of virtual servers this server is part of as node. This is a list as this server can be part of several virtual servers. (see virtualClusterServer)

#### `Server.nodes` ● `[Server!]!` non-null object​

The server nodes of this server if it is a virtual server. If this is not a virtual server this list is empty. (see virtualClusterServer)

#### `Server.activeNode` ● `Server` object​

The active server node of this server if it is a virtual server. (see virtualClusterServer)

#### `Server.sapInstances` ● `[SapInstance!]!` non-null object​

The list of SAP instances this server is monitoring.

#### `Server.sapInstanceCount` ● `Int!` non-null scalar​

The count of SAP instances.

#### `Server.sapSystems` ● `[SapSystem!]!` non-null object​

The list of SAP systems this server is involved in monitoring. It is the set of SAP systems discoverable by the sapInstances field.

#### `Server.sapSystemCount` ● `Int!` non-null scalar​

The number of SAP systems this server is involved in monitoring. It is the set of SAP systems discoverable by the sapInstances field.

#### `Server.cloudServices` ● `[CloudService!]!` non-null object​

The list of service objects this server is monitoring.

#### `Server.cloudServiceCount` ● `Int!` non-null scalar​

The count of cloud services monitored by this server.

#### `Server.businessObjects` ● `[SapBusinessObject!]!` non-null object​

The business objects monitored by this server.

#### `Server.businessObjectCount` ● `Int!` non-null scalar​

The count of SAP business objects monitored by this server.

#### `Server.databases` ● `[Database!]!` non-null object​

The databases monitored by this server.

#### `Server.databaseCount` ● `Int!` non-null scalar​

The count of databases monitored by this server.

#### `Server.actions` ● `[SystemAction!]!` non-null object​

Get all the possible system actions. They can be used with mutation executeSystemAction(...).

##### `Server.actions.actionType` ● `[SystemActionType!]` list enum​

#### `Server.performance` ● `MonitoredSystemPerformanceData` object​

This field holds information about the available performance resources for this monitored system.

#### `Server.agentVersion` ● `String` scalar​

Information about the underlying agent version if there is one.

#### `Server.administrator` ● `User` object​

Who is responsible as administrator for this system.

#### `Server.administratorDeputy` ● `User` object​

Who is responsible as administrator deputy for this system.

#### `Server.remote` ● `Boolean!` non-null scalar​

Is this a remote system

#### `Server.info` ● `[InfoNode]` list object​

Information about this monitored system.

#### `Server.assignedSLA` ● `ServiceLevelAgreement` object​

The assigned SLA (service level agreement).

#### `Server.cloudServiceAuthentication` ● `CloudServiceAuthentication` object​

If a cloud is configured this field is set (VMware is treated as a cloud provider).

#### `Server.monitorLevel` ● `MonitorLevel!` non-null enum​

The monitor level

#### `Server.credentialPurposes` ● `[CredentialsPurpose]!` non-null object​

Available credential purposes for this system.

#### `Server.credentials` ● `[CredentialsBase]!` non-null interface​

Available credentials for this system.

#### `Server.notSeen` ● `Boolean` scalar​

Whether this system is "not seen". Not seen means the system was once seen on an agent but now it isn't.

#### `Server.notifications` ● `[Notification]!` non-null interface​

Associated notification actions

##### `Server.notifications.where` ● `FilterInput` input​

##### `Server.notifications.order` ● `OrderInput` input​

#### `Server.pagedNotifications` ● `NotificationPage!` non-null object​

The paged variant for the notification field.

##### `Server.pagedNotifications.pageRequest` ● `PageRequest!` non-null input​

##### `Server.pagedNotifications.where` ● `FilterInput` input​

##### `Server.pagedNotifications.order` ● `OrderInput` input​

#### `Server.serialNumber` ● `String` scalar​

The serial number for this server.

#### `Server.managedStatus` ● `ManagedSystemStatus!` non-null enum​

Managed status for this system.

#### `Server.virtualServerConfiguration` ● `VirtualServerConfiguration` object​

Information if this is a virtual server. If not this field is null.

#### `Server.monitoringParametersGroups` ● `[MonitoringParameterGroup!]!` non-null object​

Monitoring parameter groups

#### `Server.monitoringParameterByName` ● `ValueParameter` object​

Query a single monitoring parameter by its name. Here is an example query: query MoniParams { servers { agentConnect: monitoringParameterByName(name: "AgentListenerPort") { id name values } agentEnv: monitoringParameterByName(name: "AgentEnvironment") { id name values } } }

##### `Server.monitoringParameterByName.name` ● `String!` non-null scalar​

#### `Server.draft` ● `Boolean!` non-null scalar​

Tells if a draft or a saved system.

#### `Server.application` ● `ApplicationType` object​

The application type for this monitored system.

#### `Server.changes` ● `[Change!]!` non-null object​

Changes for this monitored system.

##### `Server.changes.where` ● `FilterInput` input​

##### `Server.changes.order` ● `OrderInput` input​

#### `Server.pagedChanges` ● `ChangePage` object​

Paged changes for this monitored system.

##### `Server.pagedChanges.pageRequest` ● `PageRequest!` non-null input​

##### `Server.pagedChanges.where` ● `FilterInput` input​

##### `Server.pagedChanges.order` ● `OrderInput` input​

#### `Server.systemParameterSets` ● `[SystemParameterSet!]!` non-null object​

Returns all available system parameter sets.

### Interfaces​

#### `MonitoredSystem` interface​

Interface for a monitored system

### Returned By​

`server` query ● `servers` query ● `turnMonitoringOffForServer` mutation ● `turnMonitoringOnForServer` mutation

### Member Of​

`CloudService` object ● `CreateServerPayload` object ● `Database` object ● `SapBusinessObject` object ● `SapInstance` object ● `SapSystem` object ● `SapSystemRemoteOptions` interface ● `SapSystemWithoutSapControlRemoteOptions` object ● `SapSystemWithSapControlRemoteOptions` object ● `Server` object ● `ServerPage` object ● `UpdateServerPayload` object ● `VirtualServerConfiguration` object