Skip to main content

# MonitoredSystem

Interface for a monitored system

    interface 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
      actions(
        actionType: [SystemActionType!] = [Start, Stop, Restart]
      ): [SystemAction!]!
      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
      systemRole: String @deprecated
      role: SystemRole
      timestamp: DateTime
      type: MonitoredSystemType!
      uuid: String
      status: Status!
      statusId: Int!
      performance: MonitoredSystemPerformanceData
      administrator: User
      administratorDeputy: User
      remote: Boolean!
      info: [InfoNode]
      applicationType: String
      assignedSLA: ServiceLevelAgreement
      monitorLevel: MonitorLevel!
      credentialPurposes: [CredentialsPurpose]!
      credentials: [CredentialsBase]!
      notSeen: Boolean
      notifications(
        where: FilterInput
        order: OrderInput
      ): [Notification]!
      pagedNotifications(
        pageRequest: PageRequest!
        where: FilterInput
        order: OrderInput
      ): NotificationPage!
      application: ApplicationType
      changes(
        where: FilterInput
        order: OrderInput
      ): [Change!]!
      pagedChanges(
        pageRequest: PageRequest!
        where: FilterInput
        order: OrderInput
      ): ChangePage
      managedStatus: ManagedSystemStatus!
      monitoringParametersGroups: [MonitoringParameterGroup!]!
      monitoringParameterByName(
        name: String!
      ): ValueParameter
      draft: Boolean!
      systemParameterSets: [SystemParameterSet!]!
    }

### Fields​

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

#### `MonitoredSystem.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

#### `MonitoredSystem.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" }

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

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

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

Count the affected checks.

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

The filter conditions for this query.

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

Get a check count summary.

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

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

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

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

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

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

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

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

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

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

Custom attributes defined for this monitored system.

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

Special data for this monitored system

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

The associated customer for this system.

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

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

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

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

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

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

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

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

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

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

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

DEPRECATED

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

The role of this system.

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

The role of this system.

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

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

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

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

The status of the monitored system

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

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

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

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

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

Who is responsible as administrator for this system.

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

Who is responsible as administrator deputy for this system.

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

Is this a remote system

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

Information about this monitored system.

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

The application type of this monitored system.

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

The assigned SLA (service level agreement).

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

The monitor level

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

Available credential purposes for this system.

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

Available credentials for this system.

#### `MonitoredSystem.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.

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

Associated notification actions

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

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

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

The paged variant for the notification field.

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

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

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

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

The application type for this monitored system.

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

Changes for this monitored system.

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

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

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

Paged changes for this monitored system.

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

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

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

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

Managed status for this system.

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

Monitoring parameter groups

#### `MonitoredSystem.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 } } }

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

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

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

Returns all available system parameter sets.

### Returned By​

`system` query ● `systems` query ● `turnMonitoringOff` mutation ● `turnMonitoringOn` mutation

### Member Of​

`ActiveStep` object ● `AutomationExecution` object ● `BackupAgeParameter` object ● `BasicAuthenticationCredentials` object ● `BtpCloudFoundryCredentials` object ● `CcmsAlertNotification` object ● `Change` object ● `ChangeNotification` object ● `Check` interface ● `CheckHistoric` object ● `CheckNotification` object ● `CredentialsBase` interface ● `Customer` object ● `DailyCheckDetail` object ● `DailyCheckNotification` object ● `DependentMonitoredSystemReference` object ● `DependentMonitoredSystemsPayload` object ● `ExceptionParameter` object ● `ExecuteCheckCyclePayload` object ● `HotNewsNotification` object ● `MonitoredSystemEdge` object ● `MonitoredSystemPage` object ● `MonitoringParameterGroup` object ● `MonitoringSwitchDependentSystemsPayload` object ● `MonitoringSwitchMonitoredSystemPayload` object ● `MonitoringSwitchMonitoredSystemReference` object ● `Notification` interface ● `OAuthClientCredentials` object ● `OAuthCodeCredentials` object ● `RfcAuthenticationCredentials` object ● `RtmCheck` object ● `SapControlCredentials` object ● `SapHostControlCredentials` object ● `ServerEventNotification` object ● `SshCredentials` object ● `SystemParameterSet` object ● `SystemSelector` object ● `TicketNotification` object ● `ValueParameter` object ● `WorkflowStepEventNotification` object

### Implemented By​

`BusinessService` object ● `CloudService` object ● `Database` object ● `SapBusinessObject` object ● `SapInstance` object ● `SapSystem` object ● `Server` object