# Tutorials for AWS Systems Manager for SAP
You can manage your SAP deployments with Systems Manager for SAP using the AWS CLI or the AWS Console for SAP applications. This section provides tutorials to perform these tasks.
See the following topics for detailed tutorials.
**Topics**
+ [AWS CLI](cli.md)
+ [AWS Console for SAP applications](console.md)
# AWS CLI
Using AWS CLI, you can register SAP HANA or SAP ABAP applications, start, stop, refresh, and deregister SAP applications with Systems Manager for SAP.
**Topics**
+ [Register your SAP HANA databases with Systems Manager for SAP](register-database.md)
+ [Register your SAP ABAP application with AWS Systems Manager for SAP](register-abap.md)
+ [Start SAP application](start-sap-application.md)
+ [Stop SAP application](stop-sap-application.md)
+ [Refresh SAP application](refresh-sap-application.md)
+ [Deregister SAP application](deregister-sap-application.md)
+ [Run Configuration Checks with Systems Manager for SAP](configuration-checks.md)
# Register your SAP HANA databases with Systems Manager for SAP
You can register a single node or a high availability setup with multiple nodes for SAP HANA database with Systems Manager for SAP. Ensure that you have completed the setup perquisites described in [Get started with Systems Manager for SAP](https://docs.aws.amazon.com/ssm-sap/latest/userguide/get-started.html). Follow along these steps to register your database.
**Topics**
+ [Step 1: Create a JSON for credentials](#step1)
+ [Step 2: Register database](#step2)
+ [Step 3: Check registration status](#step3)
+ [Step 4: Verify registration](#step4)
+ [Step 5: View component summary](#step5)
+ [Backup your database – *optional*](#optional-step)
## Step 1: Create a JSON for credentials
Create a JSON file to store the credentials you created in [Register SAP HANA database credentials in AWS Secrets Manager](get-started.md#register-secrets).
```
[
{
"DatabaseName": "/",
"CredentialType": "ADMIN",
"SecretId": ""
},
{
"DatabaseName": "/",
"CredentialType": "ADMIN",
"SecretId": ""
}
]
```
+ Enter a unique name for the JSON file. For example, `SsmForSapRegistrationCredentials.json`.
+ For `DatabaseName`, ensure that you enter both, the system ID and the database name.
+ For `SecretId`, use the Secret name created in Step 4 of [Register SAP HANA database credentials in AWS Secrets Manager](get-started.md#register-secrets).
The following is an example JSON file.
```
[
{
"DatabaseName": "HDB/SYSTEMDB",
"CredentialType": "ADMIN",
"SecretId": "HANABackup"
},
{
"DatabaseName": "HDB/HDB",
"CredentialType": "ADMIN",
"SecretId": "HANABackup"
}
]
```
## Step 2: Register database
Register your SAP HANA databases using the following command.
Make sure to use the correct SAP HANA database instance number and SAP HANA database name (SID). These are different than the SAP instance number and SAP System Identifier.
**Command Template**
```
aws ssm-sap register-application --application-id --application-type HANA --instances --sap-instance-number --sid --region --credentials file://
```
**Example command with sample values**
```
aws ssm-sap register-application \
--application-id myHanaApplication \
--application-type HANA \
--instances i-0123456789abcdefg \
--sap-instance-number 00 \
--sid HDB \
--region us-east-1 \
--credentials file://SsmForSapRegistrationCredentials.json
```
**Example JSON response**
```
{
"Application": {
"Id": "myHanaApplication",
"Type": "HANA",
"Arn": "",
"Status": "REGISTERING",
"Components": [],
"LastUpdated": "2022-08-19T10:58:48.521000-07:00"
},
"OperationId": "6bd44104-d63c-449d-8007-6c1b471e3e5e" //(1)
}
```
1. Take note of this operation ID. You’ll need it in the next step.
In the preceding example, the instance number is 00 and SID is HDB. This can be verified with `/usr/sap//HDB`. For example, the path will be `/usr/sap/HDB/HDB00`.
**Note**
To register a high availability SAP HANA database, you can input either the primary or the secondary instance ID with the `--instances` parameter. For example, for a high availability SAP HANA database residing on primary node `i-0123456789abcdefg` and secondary node `i-9876543210abcdefg`, you can specify database registration in any one of the following ways.
`--instances i-0123456789abcdefg`
`--instances i-9876543210abcdefg`
## Step 3: Check registration status
The registration may take a few minutes to complete. Use the following command to check the status of the registration. Replace `` with the `OperationID` from the previous step.
```
aws ssm-sap get-operation --operation-id --region
```
## Step 4: Verify registration
Verify the registration with [GetApplication](https://docs.aws.amazon.com/ssmsap/latest/APIReference/API_GetApplication.html) API. You can also view the details of registered databases with [ListDatabases](https://docs.aws.amazon.com/ssmsap/latest/APIReference/API_ListDatabases.html) and [GetDatabase](https://docs.aws.amazon.com/ssmsap/latest/APIReference/API_GetDatabase.html) API.
**Command template**
```
aws ssm-sap get-application --application-id --region
```
**Example to get the summary of an application**
```
aws ssm-sap get-application \
--application-id myHanaApplication \
--region us-east-1
```
**Example output**
```
{
"Application": {
"Id": "myHanaApplication",
"Type": "HANA",
"Arn": "arn:aws:ssm-sap:us-east-1:123456789123:HANA/myHanaApplication",
"Status": "ACTIVATED",
"DiscoveryStatus": "SUCCESS",
"Components": [
"HDB-HDB00" //(1)
],
"LastUpdated": "2023-07-06T13:25:35.702000-07:00"
},
"Tags": {}
}
```
1. Take note of this component ID. You’ll need it in the next step.
## Step 5: View component summary
Get the component summary with [GetComponent](https://docs.aws.amazon.com/ssmsap/latest/APIReference/API_GetComponent.html) API.
```
aws ssm-sap get-component --application-id --component-id --region
```
Systems Manager for SAP provides two types of components for an SAP HANA application – parent and child.
+ `HANA` – there is only one parent component representing the logical database.
+ `HANA_NODE` – there are multiple child components representing database host entities.
See the following table for examples of single node and high availability SAP HANA database setup with Systems Manager for SAP.
**Example**
**GetComponent API output for parent component**
```
{
"Component": {
"ComponentId": "HDB-HDB00",
"ChildComponents": [
"HDB-HDB00-sapci"
],
"ApplicationId": "myHanaApplication",
"ComponentType": "HANA",
"Status": "RUNNING",
"Databases": [
"SYSTEMDB",
"HDB"
],
"Hosts": [
{
"HostName": "sapci",
"HostIp": "172.31.31.70",
"EC2InstanceId": "i-0123456789abcdefg",
"InstanceId": "i-0123456789abcdefg",
"HostRole": "LEADER",
"OsVersion": "SUSE Linux Enterprise Server 15 SP4"
}
],
"PrimaryHost": "i-0123456789abcdefg",
"LastUpdated": "2023-07-19T11:06:36.114000-07:00",
"Arn": "arn:aws:ssm-sap:us-east-1:123456789123:HANA/myHanaApplication/COMPONENT/HDB-HDB00"
},
"Tags": {}
}
```
**GetComponent API output for child component**
```
{
"Component": {
"ComponentId": "HDB-HDB00-sapci",
"ParentComponent": "HDB-HDB00",
"ApplicationId": "myHanaApplication",
"ComponentType": "HANA_NODE",
"Status": "RUNNING",
"SapHostname": "sapci.local",
"SapKernelVersion": "753, patch 1010, changelist 2124070",
"HdbVersion": "",
"Resilience": {
"HsrTier": "",
"HsrReplicationMode": "NONE",
"HsrOperationMode": "NONE"
},
"AssociatedHost": {
"Hostname": "sapci",
"Ec2InstanceId": "i-04823df91c0934025",
"OsVersion": "SUSE Linux Enterprise Server 15 SP4"
},
"LastUpdated": "2023-07-19T11:06:36.101000-07:00",
"Arn": "arn:aws:ssm-sap:us-east-1:123456789101:HANA/myHanaApplication/COMPONENT/HDB-HDB00-sapci"
},
"Tags": {}
}
```
**GetComponent API output for parent component**
```
{
"Component": {
"ComponentId": "HDB-HDB00",
"ChildComponents": [
"HDB-HDB00-sapsecdb",
"HDB-HDB00-sappridb"
],
"ApplicationId": "myHanaApplication",
"ComponentType": "HANA",
"Status": "RUNNING",
"Databases": [
"SYSTEMDB",
"HDB"
],
"LastUpdated": "2023-06-28T22:57:24.053000-07:00",
"Arn": "arn:aws:ssm-sap:us-east-1:123456789123:HANA/myHanaApplication/COMPONENT/HDB-HDB00"
},
"Tags": {}
}
```
**GetComponent API output for child component (primary)**
```
{
"Component": {
"ComponentId": "HDB-HDB00-sappridb",
"ParentComponent": "HDB-HDB00",
"ApplicationId": "myHanaApplication",
"ComponentType": "HANA_NODE",
"Status": "RUNNING",
"SapHostname": "sappridb.local",
"SapKernelVersion": "753, patch 1010, changelist 2124070",
"HdbVersion": "2.00.065.00.1665753120",
"Resilience": {
"HsrTier": "1",
"HsrReplicationMode": "PRIMARY",
"HsrOperationMode": "PRIMARY",
"ClusterStatus": "ONLINE"
},
"AssociatedHost": {
"Hostname": "sappridb",
"Ec2InstanceId": "i-0123456789abcdefg",
"OsVersion": "SUSE Linux Enterprise Server 15 SP4"
},
"LastUpdated": "2023-07-19T10:20:26.888000-07:00",
"Arn": "arn:aws:ssm-sap:us-east-1:123456789123:HANA/myHanaApplication/COMPONENT/HDB-HDB00-sappridb"
},
"Tags": {}
}
```
**GetComponent API output for child component (secondary)**
```
{
"Component": {
"ComponentId": "HDB-HDB00-sapsecdb",
"ParentComponent": "HDB-HDB00",
"ApplicationId": "myHanaApplication",
"ComponentType": "HANA_NODE",
"Status": "RUNNING",
"SapHostname": "sapsecdb.local",
"SapKernelVersion": "753, patch 1010, changelist 2124070",
"HdbVersion": "2.00.065.00.1665753120",
"Resilience": {
"HsrTier": "2",
"HsrReplicationMode": "SYNC",
"HsrOperationMode": "LOGREPLAY",
"ClusterStatus": "ONLINE"
},
"AssociatedHost": {
"Hostname": "sapsecdb",
"Ec2InstanceId": "i-0123456789abcdefg",
"OsVersion": "SUSE Linux Enterprise Server 15 SP4"
},
"LastUpdated": "2023-07-19T10:20:26.639000-07:00",
"Arn": "arn:aws:ssm-sap:us-east-1:123456789123:HANA/myHanaApplication/COMPONENT/HDB-HDB00-sapsecdb"
},
"Tags": {}
}
```
## Backup your database – *optional*
Now the registration is complete, and you can begin data protection operations, including backup and restore of your SAP HANA databases. For more details, see [AWS Backup documentation](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-saphana.html#w142aac17c15c33b5).
# Register your SAP ABAP application with AWS Systems Manager for SAP
You can register a single node or multi node (distributed or high availability) setup for SAP ABAP application with Systems Manager for SAP. Ensure that you have completed the setup perquisites described in [Get started with Systems Manager for SAP](https://docs.aws.amazon.com/ssm-sap/latest/userguide/get-started.html). Follow along these steps to register your SAP ABAP application.
**Topics**
+ [Step 1: Register database](#step1-abap)
+ [Step 2: Register application](#step2-abap)
+ [Step 3: Check registration status](#step3-abap)
+ [Step 4: Verify registration](#step4-abap)
+ [Step 5: View component summary](#step5-abap)
## Step 1: Register database
Register your SAP HANA database before registering your SAP ABAP application. For more information, see [Register your SAP HANA databases with Systems Manager for SAP](register-database.md).
Note the `ApplicationId` of your registration.
## Step 2: Register application
1. Use the `ApplicationId` noted in the previous step in the next command.
1. Use the following command to find the Amazon Resource Name (ARN) of the database.
```
aws ssm-sap list-databases --application-id
```
```
{
"Databases": [
{
"ApplicationId": "SAP_HANA_APPLICATION",
"ComponentId": "HDB-HDB00",
"DatabaseId": "SYSTEMDB",
"DatabaseType": "SYSTEM",
"Arn": "arn:aws:ssm-sap:us-east-1:123456789101:HANA/SAP_HANA_APPLICATION/DB/SYSTEMDB",
"Tags": {}
},
{
"ApplicationId": "SAP_HANA_APPLICATION",
"ComponentId": "HDB-HDB00",
"DatabaseId": "HDB",
"DatabaseType": "TENANT",
"Arn": "arn:aws:ssm-sap:us-east-1:123456789101:HANA/SAP_HANA_APPLICATION/DB/HDB", //(Note)
"Tags": {}
}
]
}
```
**Note** the `database-arn` for use in the next step.
1. Register your SAP ABAP application with the following command.
**Command template**
```
aws ssm-sap register-application \
--application-id \
--application-type SAP_ABAP \
--instances \
--sid \
--region
--database-arn
--component-info '[
{
"ComponentType": "WD",
"Sid": "",
"Ec2InstanceId": ""
}
]'
```
**Example command with sample values**
```
aws ssm-sap register-application
--application-id "mySAPABAPApplication" \
--application-type SAP_ABAP \
--instances i-0307b3e5fbdc4bda1 \
--sid ECD \
--region us-east-1 \
--database-arn "arn:aws:ssm-sap:us-east-1:123456789101:HANA/SAP_HANA_APPLICATION/DB/HDB"
--component-info '[{"ComponentType": "WD", "Sid":"WD1", "Ec2InstanceId":"i-07837dbacc572b5f2"}]'
```
**Example JSON response**
```
{
"Application": {
"Id": "mySAPABAPApplication",
"Type": "SAP_ABAP",
"Arn": "",
"Status": "REGISTERING",
"Components": [],
"LastUpdated": "2022-08-19T10:58:48.521000-07:00"
},
"OperationId": "6bd44104-d63c-449d-8007-6c1b471e3e5e" //(Note)
}
```
**Note** Take note of this operation ID. You’ll need it in the next step.
## Step 3: Check registration status
The registration may take a few minutes to complete. Use the following command to check the status of your registration. Use the `OperationId` generated when registering your SAP ABAP application in the preceding step.
```
aws ssm-sap get-operation --operation-id --region
```
## Step 4: Verify registration
Verify the registration with [GetApplication](https://docs.aws.amazon.com/ssmsap/latest/APIReference/API_GetApplication.html) API. You can also view the details of registered databases with [ListDatabases](https://docs.aws.amazon.com/ssmsap/latest/APIReference/API_ListDatabases.html) and [GetDatabase](https://docs.aws.amazon.com/ssmsap/latest/APIReference/API_GetDatabase.html) API.
1. Run Commands to Verify Registration
**Command template**
```
aws ssm-sap get-application --application-id --region
```
**Example to get the summary of an application**
```
aws ssm-sap get-application --application-id mySAPABAPApplication --region us-east-1
```
**Example JSON Response**
```
{
"Application": {
"Id": "mySAPABAPApplication",
"Type": "SAP_ABAP",
"Arn": "arn:aws:ssm-sap:us-east-1:123456789101:SAP_ABAP/mySAPABAPApplication",
"Status": "ACTIVATED",
"DiscoveryStatus": "SUCCESS",
"Components": [
"ECD-ABAP"
"WD1-WD14" //(Note)
]
"LastUpdated": "2023-10-04T22:16:59.106000-07:00"
},
"Tags": {}
}
```
**Note** Take note of this component ID. You’ll need it in the next step.
## Step 5: View component summary
Get the component summary with [GetComponent](https://docs.aws.amazon.com/ssmsap/latest/APIReference/API_GetComponent.html) API.
1. Command template
```
aws ssm-sap get-component --application-id --component-id --region
```
1. GetComponent API output for parent component ECD-ABAP
```
aws ssm-sap get-component \
--application-id mySAPABAPApplication \
--component-id ECD-ABAP \
--region us-east-1
```
**Sample JSON Output**
```
{
"Component": {
"ComponentId": "ECD-ABAP",
"Sid": "ECD",
"ChildComponents": [
"ECD-ASCS10-sapci",
"ECD-D12-sapci"
"ECD-D00-sapappser1",
"ECD-D00-sapappser2"
],
"ApplicationId": "mySAPABAPApplication",
"ComponentType": "ABAP",
"Status": "RUNNING",
"DatabaseConnection": {
"DatabaseConnectionMethod": "DIRECT",
"DatabaseArn": "arn:aws:ssm-sap:us-east-1:123456789101:HANA/SAP_HANA_APPLICATION/DB/HDB",
"ConnectionIp": "172.31.19.240"
},
"LastUpdated": "2023-10-04T22:16:59.089000-07:00",
"Arn": "arn:aws:ssm-sap:us-east-1:123456789101:SAP_ABAP/mySAPABAPApplication/COMPONENT/ECD-ABAP"
},
"Tags": {}
}
```
1. GetComponent API output for parent component WD1-W14
```
aws ssm-sap get-component --component-id WD1-W14\
--application-id mySAPABAPApplication \
--region us-east-1
```
**Sample JSON Output**
```
{
"Component": {
"ComponentId": "WD1-W14",
"Sid": "WD1",
"ChildComponents": [
"WD1-W14-sapwd"
],
"ApplicationId": "mySAPABAPApplication",
"ComponentType": "WEBDISP",
"Status": "RUNNING",
"LastUpdated": "2024-10-04T22:16:59.089000-07:00",
"Arn": "arn:aws:ssm-sap:us-east-1:123456789101:SAP_ABAP/mySAPABAPApplication/COMPONENT/WD1-W14"
},
"Tags": {}
}
```
1. GetComponent API output for child component ECD-ASCS10-sapci
```
aws ssm-sap get-component \
--component-id ECD-ASCS10-sapci --application-id mySAPABAPApplication \
--region us-east-1
```
**Sample Output**
```
{
"Component": {
"ComponentId": "ECD-ASCS10-sapci",
"Sid": "ECD",
"SystemNumber": "10",
"ParentComponent": "ECD-ABAP",
"ApplicationId": "mySAPABAPApplication",
"ComponentType": "ASCS",
"Status": "RUNNING",
"SapFeature": "MESSAGESERVER|ENQUE",
"SapHostname": "sapci",
"SapKernelVersion": "785, patch 200, changelist 2150416",
"Resilience": {
"EnqueueReplication": false
},
"AssociatedHost": {
"Hostname": "sapci",
"Ec2InstanceId": "i-0307b3e5fbdc4bda1",
"IpAddresses": [
{
"IpAddress": "172.31.19.240",
"Primary": true,
"AllocationType": "VPC_SUBNET"
}
],
"OsVersion": "SUSE Linux Enterprise Server 15 SP4"
},
"LastUpdated": "2023-10-04T22:16:58.915000-07:00",
"Arn": "arn:aws:ssm-sap:us-east-1:123456789101:SAP_ABAP/mySAPABAPApplication/COMPONENT/ECD-ASCS10-sapci"
},
"Tags": {}
}
```
1. GetComponent API for Child Component WD1-W14-sapwd
```
aws ssm-sap get-component \
--component-id WD1-W14-sapwd --application-id mySAPABAPApplication \
--region us-east-1
```
**Sample Output**
```
{
"Component": {
"ComponentId": "WD1-W14-sapwd",
"Sid": "WD1",
"SystemNumber": "14",
"ParentComponent": "WD1-W14",
"ApplicationId": "mySAPABAPApplication",
"ComponentType": "WD",
"Status": "RUNNING",
"SapFeature": "WEBDISP",
"SapHostname": "sapci",
"SapKernelVersion": "785, patch 200, changelist 2150416",
"Resilience": {
"EnqueueReplication": false
},
"AssociatedHost": {
"Hostname": "sapwd",
"Ec2InstanceId": "i-12345abcde678f9g0",
"IpAddresses": [
{
"IpAddress": "172.31.32.187",
"Primary": true,
"AllocationType": "VPC_SUBNET"
}
],
"OsVersion": "SUSE Linux Enterprise Server 15 SP4"
},
"LastUpdated": "2023-10-04T22:16:58.915000-07:00",
"Arn": "arn:aws:ssm-sap:us-east-1:123456789101:SAP_ABAP/mySAPABAPApplication/COMPONENT/WD1-W14-sapwd"
},
"Tags": {}
}
```
# Start SAP application
You can perform a start operation on a single node or HA (high availability) SAP HANA application or on a single node or distributed setup of an SAP ABAP application which is registered with AWS Systems Manager for SAP.
When starting an SAP HANA application, the Amazon EC2 instance(s) on which the SAP HANA application will run is started first (if it is not already running), before the application is started. When starting a single node setup of an SAP ABAP application, the HANA database and/or the Amazon EC2 instance on which the SAP ABAP application will run is started first (if it is not already running).
Before you initiate a start operation, complete the setup prerequisites described in [Get started with AWS Systems Manager for SAP](get-started.md) and register your SAP application, if you have not already done so.
You can start Systems Manager for SAP application using AWS CLI or AWS Management Console. The following procedure is for starting an SAP application using AWS CLI.
**Topics**
+ [Step 1: Register SAP Application](#step1-start-application)
+ [Step 2: Start SAP Application](#step2-start-application)
+ [Step 3: Check Start Operation status](#step3-start-application)
+ [Step 4: Monitor and verify Start operation](#step4-start-application)
## Step 1: Register SAP Application
Register your SAP application, if you have not already done so. For more information, see [Register SAP HANA database](https://docs.aws.amazon.com/ssm-sap/latest/userguide/register-database.html) or [Register SAP ABAP application](https://docs.aws.amazon.com/ssm-sap/latest/userguide/register-abap.html).
In your records, note the `ApplicationId` of your registration.
## Step 2: Start SAP Application
You can use the following AWS CLI command to start your SAP application:
```
aws ssm-sap start-application \
--application-id \
--region
```
The parameter `application-id` is required. As the value, use the ApplicationID generated from registration in Step 1.
**Command template**
```
aws ssm-sap start-application --application-id --region
```
**Command example**
```
aws ssm-sap start-application \
--application-id myHanaApplication \
--region us-east-1
```
**Return example**
```
{
"OperationId": "a7h4j3k6-8463-836h-018h-7sh377h6hhd6" //(Note)
}
```
**Note** the OperationId for use in the next step
## Step 3: Check Start Operation status
The start operation can take up to five minutes to complete. During that time, you can use the following command to check the status of the operation. Use the `OperationId` that was generated in Step 2.
**Command template**
```
aws ssm-sap get-operation --operation-id --region
```
## Step 4: Monitor and verify Start operation
Verify the start operation on the application through the event using the [ListOperationEvents](https://docs.aws.amazon.com/ssmsap/latest/APIReference/API_ListOperationEvents.html) API.
**Command template**
```
aws ssm-sap list-operation-events --operation-id --region
```
**Command example**
```
aws ssm-sap list-operation-events \
--operation-id b2bc3266-9369-4163-b935-6a586c80e76b \
--region us-east-1
```
**Json output**
```
{
"OperationEvents": [
{
"Description": "Start the SAP component ECD-ABAP",
"Resource": {
"ResourceArn": "arn:aws:ssm-sap:us-east-1:111111111111:SAP_ABAP/nwStartStop/COMPONENT/ECD-ABAP",
"ResourceType": "AWS::SystemsManagerSAP::Component"
},
"Status": "COMPLETED",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:53:59.846000+00:00"
},
{
"Description": "Start the SAP component ECD-D12-sapci",
"Resource": {
"ResourceArn": "arn:aws:ssm-sap:us-east-1:111111111111:SAP_ABAP/nwStartStop/COMPONENT/ECD-D12-sapci",
"ResourceType": "AWS::SystemsManagerSAP::Component"
},
"Status": "COMPLETED",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:52:59.846000+00:00"
},
{
"Description": "Start the SAP component ECD-D12-sapci",
"Resource": {
"ResourceArn": "arn:aws:ssm-sap:us-east-1:111111111111:SAP_ABAP/nwStartStop/COMPONENT/ECD-D12-sapci",
"ResourceType": "AWS::SystemsManagerSAP::Component"
},
"Status": "IN_PROGRESS",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:51:59.846000+00:00"
},
{
"Description": "Start the SAP component ECD-ASCS10-sapci",
"Resource": {
"ResourceArn": "arn:aws:ssm-sap:us-east-1:111111111111:SAP_ABAP/nwStartStop/COMPONENT/ECD-ASCS10-sapci",
"ResourceType": "AWS::SystemsManagerSAP::Component"
},
"Status": "COMPLETED",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:50:59.846000+00:00"
},
{
"Description": "Start the SAP component ECD-ASCS10-sapci",
"Resource": {
"ResourceArn": "arn:aws:ssm-sap:us-east-1:111111111111:SAP_ABAP/nwStartStop/COMPONENT/ECD-ASCS10-sapci",
"ResourceType": "AWS::SystemsManagerSAP::Component"
},
"Status": "IN_PROGRESS",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:49:59.846000+00:00"
},
{
"Description": "Start the SAP component ECD-ABAP",
"Resource": {
"ResourceArn": "arn:aws:ssm-sap:us-east-1:111111111111:SAP_ABAP/nwStartStop/COMPONENT/ECD-ABAP",
"ResourceType": "AWS::SystemsManagerSAP::Component"
},
"Status": "IN_PROGRESS",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:48:59.846000+00:00"
},
{
"Description": "Start the SAP component HDB-HDB00",
"Resource": {
"ResourceArn": "arn:aws:ssm-sap:us-east-1:111111111111:HANA/hanaStartStop/COMPONENT/HDB-HDB00",
"ResourceType": "AWS::SystemsManagerSAP::Component"
},
"Status": "COMPLETED",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:47:59.856000+00:00"
},
{
"Description": "Start the SAP component HDB-HDB00-sapci",
"Resource": {
"ResourceArn": "arn:aws:ssm-sap:us-east-1:111111111111:HANA/hanaStartStop/COMPONENT/HDB-HDB00-sapci",
"ResourceType": "AWS::SystemsManagerSAP::Component"
},
"Status": "COMPLETED",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:47:59.846000+00:00"
},
{
"Description": "Start the SAP component HDB-HDB00-sapci",
"Resource": {
"ResourceArn": "arn:aws:ssm-sap:us-east-1:111111111111:HANA/hanaStartStop/COMPONENT/HDB-HDB00-sapci",
"ResourceType": "AWS::SystemsManagerSAP::Component"
},
"Status": "IN_PROGRESS",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:46:59.846000+00:00"
},
{
"Description": "Start the SAP component HDB-HDB00",
"Resource": {
"ResourceArn": "arn:aws:ssm-sap:us-east-1:111111111111:HANA/hanaStartStop/COMPONENT/HDB-HDB00",
"ResourceType": "AWS::SystemsManagerSAP::Component"
},
"Status": "IN_PROGRESS",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:46:59.836000+00:00"
},
{
"Description": "Start the EC2 instance i-abcdefgh987654321",
"Resource": {
"ResourceArn": "arn:aws:ec2:us-east-1:111111111111:instance/i-abcdefgh987654321",
"ResourceType": "AWS::EC2::Instance"
},
"Status": "COMPLETED",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:45:59.846000+00:00"
},
{
"Description": "Start the EC2 instance i-abcdefgh987654321",
"Resource": {
"ResourceArn": "arn:aws:ec2:us-east-1:111111111111:instance/i-abcdefgh987654321",
"ResourceType": "AWS::EC2::Instance"
},
"Status": "IN_PROGRESS",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:44:59.846000+00:00"
}
]
}
```
# Stop SAP application
You can perform a stop operation on a single node or HA (high availability) SAP HANA application or on a single node or distrubuted setup of SAP ABAP application that has been registered with AWS Systems Manager for SAP.
While performing the stop operation on an SAP HANA application, you can optionally also stop the Amazon EC2 instance(s) on which the SAP HANA application is running. While performing a stop operation on a single node setup of SAP ABAP application, you can optionally also stop the HANA database application and the Amazon EC2 instance on which the SAP ABAP application is running.
Before you initiate a stop operation, complete the setup prerequisites described in [Get started with AWS Systems Manager for SAP](get-started.md) and register your SAP application, if you have not already done so.
You can stop Systems Manager for SAP application using AWS CLI or AWS Management Console. The following procedure is for stopping an SAP application using AWS CLI.
**Topics**
+ [Step 1: Register SAP Application](#step1-stop-application)
+ [Step 2: Stop SAP Application](#step2-stop-application)
+ [Step 3: Check Stop Operation status](#step3-stop-application)
+ [Step 4: Monitor and verify stop operation](#step4-stop-application)
## Step 1: Register SAP Application
Register your SAP application, if you have not already done so. For more information, see [Register SAP HANA database](https://docs.aws.amazon.com/ssm-sap/latest/userguide/register-database.html) or [Register SAP ABAP application](https://docs.aws.amazon.com/ssm-sap/latest/userguide/register-abap.html).
## Step 2: Stop SAP Application
You can use the following AWS CLI command to stop your SAP application:
```
aws ssm-sap stop-application \
--application-id \
--stop-connected-entity \
--include-ec2-instance-shutdown \
--region
```
The parameter `application-id` is required. As the value, use the ApplicationID generated from registration in Step 1.
The following parameters are optional:
+ Use the `stop-connected-entity` parameter with a value of `DBMS` (Database Management System) to also stop the corresponding database application when you stop a single node setup of an SAP ABAP application.
+ Use the Boolean parameter `include-ec2-instance-shutdown` to shut down the Amazon EC2 instance on which the SAP HANA or single node set up of an SAP ABAP application is running
The following are examples of the stop operation on a single node SAP ABAP setup and an SAP HANA setup with AWS Systems Manager for SAP:
**Example**
**Command template**
```
aws ssm-sap stop-application --application-id --stop-connected-entity --include-ec2-instance-shutdown --region
```
**Command example**
```
aws ssm-sap stop-application \
--application-id myABAPApplication \
--stop-connected-entity DBMS \
--include-ec2-instance-shutdown \
--region us-east-1
```
**Return example**
```
{
"OperationId": "a7h4j3k6-8463-836h-018h-7sh377h6hhd6"
}
```
**Command template**
```
aws ssm-sap stop-application --application-id --include-ec2-instance-shutdown --region
```
**Command example**
```
aws ssm-sap stop-application \
--application-id myABAPApplication \
--include-ec2-instance-shutdown \
--region us-east-1
```
**Return Example**
```
{
"OperationId": "j3h5j4k5-8323-192j-102n-18h7hhh27h27"
}
```
## Step 3: Check Stop Operation status
The stop operation can take up to five minutes to complete. During that time, you can use the following command to check the status of the operation. Use the `OperationId` that was generated in Step 2.
**Command template**
```
aws ssm-sap get-operation --operation-id --region
```
**Command example**
```
aws ssm-sap get-operation \
--operation-id b2bc3266-9369-4163-b935-6a586c80e76b \
--region us-east-1
```
## Step 4: Monitor and verify stop operation
Verify the stop operation on the application through the event using the [ListOperationEvents](https://docs.aws.amazon.com/ssmsap/latest/APIReference/API_ListOperationEvents.html) API.
**Command template**
```
aws ssm-sap list-operation-events --operation-id --region
```
**Command example**
```
aws ssm-sap list-operation-events \
--operation-id a1bc2345-6789-0123-d456-7e890f12g34h
```
**Return example**
```
{
"OperationEvents": [
{
"Description": "Stop the EC2 instance i-abcdefgh987654321",
"Resource": {
"ResourceArn": "arn:aws:ec2:us-east-1:111111111111:instance/i-abcdefgh987654321",
"ResourceType": "AWS::EC2::Instance"
},
"Status": "COMPLETED",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:55:59.846000+00:00"
},
{
"Description": "Stop the EC2 instance i-abcdefgh987654321",
"Resource": {
"ResourceArn": "arn:aws:ec2:us-east-1:111111111111:instance/i-abcdefgh987654321",
"ResourceType": "AWS::EC2::Instance"
},
"Status": "IN_PROGRESS",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:54:59.846000+00:00"
},
{
"Description": "Stop the SAP component HDB-HDB00",
"Resource": {
"ResourceArn": "arn:aws:ssm-sap:us-east-1:111111111111:HANA/hanaStartStop/COMPONENT/HDB-HDB00",
"ResourceType": "AWS::SystemsManagerSAP::Component"
},
"Status": "COMPLETED",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:53:59.846000+00:00"
},
{
"Description": "Stop the SAP component HDB-HDB00-sapci",
"Resource": {
"ResourceArn": "arn:aws:ssm-sap:us-east-1:111111111111:HANA/hanaStartStop/COMPONENT/HDB-HDB00-sapci",
"ResourceType": "AWS::SystemsManagerSAP::Component"
},
"Status": "COMPLETED",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:52:59.846000+00:00"
},
{
"Description": "Stop the SAP component HDB-HDB00-sapci",
"Resource": {
"ResourceArn": "arn:aws:ssm-sap:us-east-1:111111111111:HANA/hanaStartStop/COMPONENT/HDB-HDB00-sapci",
"ResourceType": "AWS::SystemsManagerSAP::Component"
},
"Status": "IN_PROGRESS",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:51:59.846000+00:00"
},
{
"Description": "Stop the SAP component HDB-HDB00",
"Resource": {
"ResourceArn": "arn:aws:ssm-sap:us-east-1:111111111111:HANA/hanaStartStop/COMPONENT/HDB-HDB00",
"ResourceType": "AWS::SystemsManagerSAP::Component"
},
"Status": "IN_PROGRESS",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:50:59.846000+00:00"
},
{
"Description": "Stop the SAP component ECD-ABAP",
"Resource": {
"ResourceArn": "arn:aws:ssm-sap:us-east-1:111111111111:SAP_ABAP/nwStartStop/COMPONENT/ECD-ABAP",
"ResourceType": "AWS::SystemsManagerSAP::Component"
},
"Status": "COMPLETED",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:49:59.846000+00:00"
},
{
"Description": "Stop the SAP component ECD-ASCS10-sapci",
"Resource": {
"ResourceArn": "arn:aws:ssm-sap:us-east-1:111111111111:SAP_ABAP/nwStartStop/COMPONENT/ECD-ASCS10-sapci",
"ResourceType": "AWS::SystemsManagerSAP::Component"
},
"Status": "COMPLETED",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:48:59.846000+00:00"
},
{
"Description": "Stop the SAP component ECD-ASCS10-sapci",
"Resource": {
"ResourceArn": "arn:aws:ssm-sap:us-east-1:111111111111:SAP_ABAP/nwStartStop/COMPONENT/ECD-ASCS10-sapci",
"ResourceType": "AWS::SystemsManagerSAP::Component"
},
"Status": "IN_PROGRESS",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:47:59.846000+00:00"
},
{
"Description": "Stop the SAP component ECD-D12-sapci",
"Resource": {
"ResourceArn": "arn:aws:ssm-sap:us-east-1:111111111111:SAP_ABAP/nwStartStop/COMPONENT/ECD-D12-sapci",
"ResourceType": "AWS::SystemsManagerSAP::Component"
},
"Status": "COMPLETED",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:46:59.846000+00:00"
},
{
"Description": "Stop the SAP component ECD-D12-sapci",
"Resource": {
"ResourceArn": "arn:aws:ssm-sap:us-east-1:111111111111:SAP_ABAP/nwStartStop/COMPONENT/ECD-D12-sapci",
"ResourceType": "AWS::SystemsManagerSAP::Component"
},
"Status": "IN_PROGRESS",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:45:59.846000+00:00"
},
{
"Description": "Stop the SAP component ECD-ABAP",
"Resource": {
"ResourceArn": "arn:aws:ssm-sap:us-east-1:111111111111:SAP_ABAP/nwStartStop/COMPONENT/ECD-ABAP",
"ResourceType": "AWS::SystemsManagerSAP::Component"
},
"Status": "IN_PROGRESS",
"StatusMessage": "",
"Timestamp": "2024-01-03T04:44:59.846000+00:00"
}
]
}
```
# Refresh SAP application
The following steps will guide you through a refresh of your SAP HANA application or of your single node setup of SAP ABAP application. This refresh updates the application metadata in the AWS Systems Manager for SAP.
Before you refresh an application, complete the setup prerequisites described in [Get started with AWS Systems Manager for SAP](get-started.md) and register your SAP application if you have not already done so.
## Step 1: Register SAP Application
Register your SAP application, if you have not already done so. For more information, see [Register SAP HANA database](https://docs.aws.amazon.com/ssm-sap/latest/userguide/register-database.html) or [Register SAP ABAP application](https://docs.aws.amazon.com/ssm-sap/latest/userguide/register-abap.html).
In your records, note the `ApplicationId` of your registration.
## Step 2: Refresh SAP Application
You can use the following AWS CLI command to refresh your SAP application:
```
aws ssm-sap start-application-refresh \
--application-id \
--region
```
The parameter `application-id` is required. As the value, use the ApplicationID generated from registration in Step 1.
## Step 3: Check Refresh Operation status
The refresh operation can take up to five minutes to complete. During that time, you can use the following command to check the status of the operation. Use the `OperationId` generated in Step 2.
**Command template**
```
aws ssm-sap get-operation \
--operation-id \
--region
```
## Step 4: Verify application status
Use the command [get-application](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-sap/get-application.html) ([GetApplication](https://docs.aws.amazon.com/ssmsap/latest/APIReference/API_GetApplication.html) API) to verify the application status. You can also view the details of registered databases with `ListDatabases` and `GetDatabase` API.
**Command template**
```
aws ssm-sap get-application --application-id --region
```
**Example to get the summary of an application**
```
aws ssm-sap get-application \
--application-id mySAPABAPApplication \
--region us-east-1
```
**Response example**
```
{
"Application": {
"Id": "mySAPABAPApplication",
"Type": "SAP_ABAP",
"Arn": "arn:aws:ssm-sap:us-east-1:123456789101:SAP_ABAP/mySAPABAPApplication",
"Status": "ACTIVATED",
"DiscoveryStatus": "SUCCESS",
"Components": [
"ECD-ABAP"
],
"LastUpdated": "2023-10-04T22:16:59.106000-07:00"
},
"Tags": {}
}
```
# Deregister SAP application
The following steps will guide you through deregistration your SAP HANA application or of your single node setup of SAP ABAP application registered with Systems Manager for SAP.
If a database has not been previously registered with AWS Systems Manager, the deregistration process will result in a `ValidationException`.
## Step 1: Get ApplicationId of your SAP application
**Command template**
```
aws ssm-sap list-applications --region
```
Note the `ApplicationId` of your registration.
## Step 2: Deregister SAP application
You can use the AWS CLI command [deregister-application](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-sap/deregister-application.html) (API [DeregisterApplication](https://docs.aws.amazon.com/ssmsap/latest/APIReference/API_DeregisterApplication.html)) to deregister your SAP application.
**Command template**
```
aws ssm-sap deregister-application --application-id --region
```
The parameter `application-id` is required. As the value, use the ApplicationID retrieved in Step 1.
## Step 3: Verify deregistration
Run the command [list-applications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-sap/list-applications.html) ([ListApplications](https://docs.aws.amazon.com/ssmsap/latest/APIReference/API_ListApplications.html) API) to verify your application is not present.
# Run Configuration Checks with Systems Manager for SAP
You can run configuration checks on your registered SAP applications to validate their setup and ensure they follow best practices. Configuration checks are organized to help you execute checks and understand their results:
+ **Configuration Check** - The top level at which checks are executed. Each check comprehensively answers a question such as "Have I chosen the right instance?" or "Is my storage configured correctly?"
+ **SubCheck** - A logical grouping used to organize and view results. SubChecks group related information based on how it is gathered or defined. For example, all package status checks or parameters for a specific resource might be grouped into one subcheck.
+ **Results** - Individual findings that evaluate a single parameter or configuration point in the system. Results can apply to a resource or be evaluated against the application. For example, "This package is installed on the primary HANA instance" or "Timezone is consistent across both the primary and secondary instances".
You start configuration checks at the check level, while subchecks and results provide structured ways to view and understand the findings.
**Topics**
+ [Run Configuration Checks](#executing-checks)
+ [Reviewing Configuration Check Results](#reviewing-results)
## Run Configuration Checks
### Step 1: View Available Checks
View the list of available configuration checks to determine which checks you wish to evaluate for your SAP application.
**Command template**
```
aws ssm-sap list-configuration-check-definitions --region
```
**Example command with sample values**
```
aws ssm-sap list-configuration-check-definitions --region us-east-1
```
**Example JSON response**
```
{
"ConfigurationChecks": [
{
"Id": "SAP_CHECK_01",
"Name": "SAP EC2 Instance Type Selection",
"Description": "Checks any EC2 Instances Associated with this HANA Application, and evaluates whether the Instance Type complies with SAP Certification requirements and that necessary hardware settings are in place.",
"ApplicableApplicationTypes": [
"HANA"
]
},
{
"Id": "SAP_CHECK_02",
"Name": "SAP HANA EBS Storage Configuration",
"Description": "Application SAP HANA EBS Storage Configuration on Amazon EC2 Instances",
"ApplicableApplicationTypes": [
"HANA"
]
},
{
"Id": "SAP_CHECK_03",
"Name": "SAP HANA Pacemaker Configuration",
"Description": "Application SAP HANA Resilience - Pacemaker Cluster Configuration",
"ApplicableApplicationTypes": [
"HANA"
]
}
]
}
```
1. Use the check IDs (such as SAP\$1CHECK\$101) when you want to start specific checks rather than running all available checks.
### Step 2: Start Configuration Checks
Start the configuration checks for your application. You can run all available checks specify individual check ids. If no configuration-check-ids are specified, all checks will be run.
**Command template**
```
aws ssm-sap start-configuration-checks \
--application-id \
--configuration-check-ids \
--region
```
**Example command with sample values**
```
aws ssm-sap start-configuration-checks \
--application-id myHanaApplication \
--configuration-check-ids SAP_CHECK_03 \
--region us-east-1
```
**Example JSON response**
```
{
"ConfigurationCheckOperations": [
{
"Id": "af3142c1-f178-49e7-a390-ad047e2d518d", //(1)
"ApplicationId": "myHanaApplication",
"ConfigurationCheckId": "SAP_CHECK_03",
"ConfigurationCheckName": "SAP HANA Pacemaker Configuration",
"ConfigurationCheckDescription": "Application SAP HANA Resilience - Pacemaker Cluster Configuration"
}
]
}
```
1. Take note of this operation ID. You’ll need it to check the status and view results.
### Step 3: Monitor Check Status
The configuration checks may take several minutes to complete. Use the following command to check the status.
**Command template**
```
aws ssm-sap get-configuration-check-operation --operation-id --region
```
**Example command with sample values**
```
aws ssm-sap get-configuration-check-operation \
--operation-id 6bd44104-d63c-449d-8007-6c1b471e3e5e \
--region us-east-1
```
**Example JSON response in progress**
```
{
"ConfigurationCheckOperation": {
"Id": "12345678-abcd-efab-cdef-123456789abc",
"ApplicationId": "HANA_H4H",
"Status": "INPROGRESS",
"ConfigurationCheckId": "SAP_CHECK_03",
"ConfigurationCheckName": "SAP HANA Pacemaker Configuration",
"ConfigurationCheckDescription": "Application SAP HANA Resilience - Pacemaker Cluster Configuration",
"StartTime": "2025-08-25T14:11:39.080000+10:00"
}
}
```
**Example JSON response successful**
```
{
"ConfigurationCheckOperation": {
"Id": "12345678-abcd-efab-cdef-123456789abc",
"ApplicationId": "HANA_H4H",
"Status": "SUCCESS",
"StatusMessage": "Configuration Check operation completed successfully",
"ConfigurationCheckId": "SAP_CHECK_03",
"ConfigurationCheckName": "SAP HANA Pacemaker Configuration",
"ConfigurationCheckDescription": "Application SAP HANA Resilience - Pacemaker Cluster Configuration",
"StartTime": "2025-08-25T14:11:39.080000+10:00",
"EndTime": "2025-08-25T14:14:32.262000+10:00",
"RuleStatusCounts": {
"Failed": 6,
"Warning": 5,
"Info": 10,
"Passed": 144,
"Unknown": 0
}
}
}
```
## Reviewing Configuration Check Results
Configuration check results are organized hierarchically. Start by identifying the check operation you want to review, then drill down through subchecks to view individual rule results.
### Step 1: List Check Operations
View the history of configuration check operations. Each operation represents a complete execution of one or more configuration checks. You can list all operations or just the latest operation for each check type.
**Command template**
```
aws ssm-sap list-configuration-check-operations \
--application-id \
--region \
--list-mode
```
The `--list-mode` parameter accepts two values:
+ `ALL_OPERATIONS` (default) - Lists all configuration check operations
+ `LATEST_PER_CHECK` - Lists only the most recent operation for each check type
**Example command with sample values**
```
aws ssm-sap list-configuration-check-operations \
--application-id myHanaApplication \
--region us-east-1 \
--list-mode LATEST_PER_CHECK
```
**Example JSON response**
```
{
"ConfigurationCheckOperations": [
{
"Id": "12345678-abcd-efab-cdef-123456789abc",
"ApplicationId": "HANA_H4H",
"Status": "SUCCESS",
"StatusMessage": "Configuration Check operation completed successfully",
"ConfigurationCheckId": "SAP_CHECK_03",
"ConfigurationCheckName": "SAP HANA Pacemaker Configuration",
"ConfigurationCheckDescription": "Application SAP HANA Resilience - Pacemaker Cluster Configuration",
"StartTime": "2025-08-25T14:11:39.080000+10:00",
"EndTime": "2025-08-25T14:14:32.262000+10:00",
"RuleStatusCounts": {
"Failed": 6,
"Warning": 5,
"Info": 10,
"Passed": 144,
"Unknown": 0
}
},
{
"Id": "98765432-dcba-abcd-efab-987654321def",
"ApplicationId": "HANA_H4H",
"Status": "SUCCESS",
"StatusMessage": "Configuration Check operation completed successfully",
"ConfigurationCheckId": "SAP_CHECK_02",
"ConfigurationCheckName": "SAP HANA EBS Storage Configuration",
"ConfigurationCheckDescription": "Application SAP HANA EBS Storage Configuration on Amazon EC2 Instances",
"StartTime": "2025-08-25T14:11:38.961000+10:00",
"EndTime": "2025-08-25T14:12:35.030000+10:00",
"RuleStatusCounts": {
"Failed": 7,
"Warning": 20,
"Info": 43,
"Passed": 40,
"Unknown": 0
}
},
{
"Id": "11223344-aabb-ccdd-eeff-112233445566",
"ApplicationId": "HANA_H4H",
"Status": "SUCCESS",
"StatusMessage": "Configuration Check operation completed successfully",
"ConfigurationCheckId": "SAP_CHECK_01",
"ConfigurationCheckName": "SAP EC2 Instance Type Selection",
"ConfigurationCheckDescription": "Checks any EC2 Instances Associated with this HANA Application, and evaluates whether the Instance Type complies with SAP Certification requirements and that necessary hardware settings are in place",
"StartTime": "2025-08-25T14:11:38.807000+10:00",
"EndTime": "2025-08-25T14:12:25.237000+10:00",
"RuleStatusCounts": {
"Failed": 0,
"Warning": 2,
"Info": 8,
"Passed": 36,
"Unknown": 0
}
}
]
}
```
### Step 2: View Sub-Check Results
Each configuration check is divided into subchecks that group related rules together. For example, a subcheck might focus on package status checks or parameters for a specific resource. list-sub-check-results provides the subcheck-ids which allow you to view the detailed reuslts.
**Command template**
```
aws ssm-sap list-sub-check-results --operation-id --region
```
**Example command with sample values**
```
aws ssm-sap list-sub-check-results \
--operation-id 6bd44104-d63c-449d-8007-6c1b471e3e5e \
--region us-east-1
```
**Example JSON response**
```
{
"SubCheckResults": [
{
"Id": "55667788-1122-3344-5566-778899aabbcc",
"Name": "Operating System Package Prerequisites",
"Description": "Validates required Operating System packages for SAP HANA High Availability are installed and aligned between cluster nodes. Requirements are based on known restrictions for Operating System, Version and SAP HANA Revision",
"References": [
"[SAP on AWS Hana High Availability Configuration / Red Hat / Prerequisites / Operating System Requirements / Packages](https://docs.aws.amazon.com/sap/latest/sap-hana/sap-hana-pacemaker-rhel-os-settings.html#packages)",
"[SAP on AWS Hana High Availability Configuration / SUSE / Prerequisites / Operating System Requirements / Packages](https://docs.aws.amazon.com/sap/latest/sap-hana/sap-hana-pacemaker-sles-os-settings.html#packages)"
]
},
{
"Id": "abcdef12-3456-7890-abcd-ef1234567890",
"Name": "Linux Systemd Service Configuration",
"Description": "Validates systemd service status and enablement for required High Availability services including Corosync and Pacemaker",
"References": [
"[SAP on AWS Hana High Availability Configuration / Red Hat / Prerequisites / Operating System Requirements](https://docs.aws.amazon.com/sap/latest/sap-hana/sap-hana-pacemaker-rhel-os-settings.html)",
"[SAP on AWS Hana High Availability Configuration / SUSE / Prerequisites / Operating System Requirements](https://docs.aws.amazon.com/sap/latest/sap-hana/sap-hana-pacemaker-sles-os-settings.html)"
]
},
// additional subchecks
]
}
```
**Note** Take note of the sub-check result IDs. You’ll need them to view detailed rule results.
### Step 3: View Rule Results
View the detailed results for each rule within a sub-check.
**Command template**
```
aws ssm-sap list-sub-check-rule-results --sub-check-result-id --region
```
**Example command with sample values**
```
aws ssm-sap list-sub-check-rule-results \
--sub-check-result-id 197fad22-aa0a-4fbf-a26a-1d2f034ffa46 \
--region us-east-1
```
**Example JSON response**
```
{
"RuleResults": [
{
"Id": "52df02e1-511d-4023-ba61-617a71c5f0c9",
"Description": "Pacemaker cluster property 'stonith-enabled' matches SAP HANA cluster recommendations",
"Status": "PASSED",
"Message": "STONITH is enabled for cluster fencing",
"Metadata": {
"ActualValue": "true",
"ClusterParameter": "stonith-enabled",
"Component": "H4H-HDB00",
"ExpectedValue": "true"
}
},
{
"Id": "d3501b51-c675-467c-8fd6-76741fafe32a",
"Description": "Pacemaker cluster property 'stonith-action' matches SAP HANA cluster recommendations",
"Status": "PASSED",
"Message": "STONITH action configured for controlled node recovery",
"Metadata": {
"ActualValue": "off",
"ClusterParameter": "stonith-action",
"Component": "H4H-HDB00",
"ExpectedValue": "off"
}
},
{
"Id": "281bbdf3-65c8-4b44-bdef-109190ee6201",
"Description": "Pacemaker cluster property 'stonith-timeout' matches SAP HANA cluster recommendations",
"Status": "PASSED",
"Message": "STONITH timeout configured to allow sufficient time for fencing operations",
"Metadata": {
"ActualValue": "600",
"ClusterParameter": "stonith-timeout",
"Component": "H4H-HDB00",
"ExpectedValue": "600"
}
},
// additional rules
]
}
```
# AWS Console for SAP applications
The AWS Console for SAP applications provides a centralized view for managing your SAP applications on AWS. To open the console, search for "AWS for SAP" in the AWS Management Console search bar, or navigate directly to https://console.aws.amazon.com/awsforsap/home.
**Topics**
+ [Console overview](console-overview.md)
+ [Register an application](register-console.md)
+ [Manage SAP applications](manage-console.md)
+ [Run Configuration Checks](configuration-checks-console.md)
# Console overview
The AWS Console for SAP applications provides a summary of all SAP applications registered with Systems Manager for SAP in your account and Region.
## Dashboard
The Dashboard provides an overview of your SAP environment in the current Region, including the registration and discovery status of your applications, running application states, resource usage, and a summary of recent operations.
From the Dashboard, you can choose **Register** to register an existing SAP application, or choose **Launch** to deploy a new application using AWS Launch Wizard for SAP.
## Applications
The Applications page lists all SAP applications registered with Systems Manager for SAP in the current Region. You can search for applications and view the application ID, type, application status, discovery status, and last updated time.
Select an application to view a summary of its details, including the application status, discovery status, ARN, running components, and SAP configuration check status. From the **Actions** menu, you can perform operations such as starting or stopping an application, updating credentials, or running on-demand discovery.
To view the full details and manage an application, choose the application ID to open the application details page. For more information, see [Application details](manage-console.md#application-details).
# Register an application
You can register SAP HANA and SAP ABAP applications using the AWS Console for SAP applications.
**Topics**
+ [Register SAP HANA database](#register-hana)
+ [Register SAP ABAP application](#register-abap)
## Register SAP HANA database
Follow these steps to register an SAP HANA database as a Systems Manager for SAP application.
1. Open the [AWS Console for SAP applications](https://console.aws.amazon.com/awsforsap/home).
1. Choose **Register application**.
1. For Application type, select **SAP HANA**.
1. In **Application details**, enter a name for the application that you want to register.
1. In **SAP HANA workload**, provide details of your workload.
1. **Instance ID** – This is the Amazon EC2 instance ID where your workload is currently running. Choose **Browse instances**, and select the instance ID for your primary SAP HANA workload.
1. **SAP System Identifier (SID)** – This is the SAP System Identifier (`sapsid`) of your SAP HANA instance.
1. **SAP system number** – This is the system number of your SAP HANA instance.
1. **Credentials** – These are the credentials of your database.
**Note**
If you do not see the credentials for the application you want to register in the **Secret ID** drop-down list, ensure that you have registered your credentials with AWS Secrets Manager. For more information, see [Register SAP HANA database credentials in AWS Secrets Manager](https://docs.aws.amazon.com/ssm-sap/latest/userguide/get-started.html#register-secrets).
*Optional* Select **Add credentials** to add credentials for five databases.
1. *Optional* In **Application tags**, you can add 100 tags associated to resources.
1. Choose **Create**.
On registration completion, you can see your application on the **Applications** page. For more information about the application details page, see [Application details](manage-console.md#application-details).
## Register SAP ABAP application
**Important**
You must register the SAP HANA database you want to connect to the SAP ABAP application before registering the SAP ABAP application.
Follow these steps to register either a single node or a multi node (distributed or high availability) SAP ABAP as a Systems Manager for SAP application.
1. Open the [AWS Console for SAP applications](https://console.aws.amazon.com/awsforsap/home).
1. Choose **Register application**.
1. For Application type, select **SAP ABAP**.
1. In **Application details**, enter a name for the application that you want to register.
1. Provide the following details of your workload.
1. **Instance ID** – This is the Amazon EC2 instance ID where your workload is currently running. Choose **Browse instances**, and select the instance ID for your primary SAP ABAP workload.
1. **SAP System Identifier (SID)** – This is the SAP System Identifier (`sapsid`) of your SAP ABAP instance.
1. **SAP HANA database Amazon Resource Name (ARN)** – This is the Amazon Resource Name (ARN) of the SAP HANA database you want to connect to your SAP ABAP application.
+ Select **Browse databases** to choose the database.
+ Select **Register a new application** to register an SAP HANA database to connect to the SAP ABAP application. You can refresh the database list on successful completion of the SAP HANA application.
1. (*Optional*). In **Connected Web Dispatcher components** you can provide the following details of up to 5 of your SAP Web Dispatcher resources that your application is using. SAP Web Dispatcher resources are only discoverable by Systems Manager for SAP after you input these details:
1. **SAP System Identifier (SID)** is the SAP System Identifier (`sapsid`) of your SAP Web Dispatcher resource.
1. **Instance ID** is the Amazon EC2 instance ID on which your SAP Web Dispatcher is currently running. Select **Browse instances** to find the instance ID.
1. (*Optional*). In **Application tags**, you can add 100 tags associated to resources.
1. Choose **Create**.
On registration completion, you can see your application on the **Applications** page. For more information about the application details page, see [Application details](manage-console.md#application-details).
# Manage SAP applications
From the AWS Console for SAP applications, you can view application details, start and stop applications, and monitor operations.
**Topics**
+ [Application details](#application-details)
+ [Start an application](#start-application)
+ [Stop an application](#stop-application)
## Application details
To view the details of a registered application, open the [AWS Console for SAP applications](https://console.aws.amazon.com/awsforsap/home), choose **Applications**, and then choose the application. The application details page contains the following tabs.
**Example**
View the topology of your Systems Manager for SAP application, including type and status. The child components are embedded under parent components. Select each component to view its details. Tenant database details can be viewed from components of type HANA.
View the EC2 instances and EBS volumes associated with your Systems Manager for SAP application.
View a summary of AWS Backup recovery points and backup jobs for your Systems Manager for SAP application. To modify backup schedules or manage backups, choose **Go to AWS Backup** to open the AWS Backup console. This tab is only available for SAP HANA applications.
View system and application tags assigned to your Systems Manager for SAP application as key-value pairs. Choose **Manage user tags** to add, modify, or delete tags.
View the results of previous configuration check evaluations by selecting a check, or choose **Run checks** to perform a new evaluation. For more information, see [Run Configuration Checks](configuration-checks-console.md).
View operations performed on your Systems Manager for SAP application. Select an operation ID to view more details and events associated with that operation.
View cost information for your Systems Manager for SAP application. AWS Cost Explorer uses tags to track your application costs. Choose **Activate application tags** to activate the tags associated with your application. Cost Explorer can take up to 24 hours to report costs after activating tags. For more information, see [Using cost allocation tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html).
Costs are calculated based on the AWS resources used by your application. Keep this in mind when evaluating single-node setups where SAP HANA and SAP ABAP share the same EC2 instance, or other configurations where applications share resources.
## Start an application
Follow these steps to start a Systems Manager for SAP application.
1. Open the [AWS Console for SAP applications](https://console.aws.amazon.com/awsforsap/home).
1. Choose **Applications**, then choose the application that you want to start.
1. Choose **Actions**, then choose **Start application**.
1. Choose **Start**.
You can monitor the task status using the *operation ID* provided in the flash banner or by choosing the **Operations** tab.
## Stop an application
Follow these steps to stop a Systems Manager for SAP application.
1. Open the [AWS Console for SAP applications](https://console.aws.amazon.com/awsforsap/home).
1. Choose **Applications**, then choose the application that you want to stop.
1. Choose **Actions**, then choose **Stop application**.
1. When stopping an SAP HANA application, you can also stop the associated EC2 instance where the SAP HANA application is running.
1. When stopping an SAP ABAP application, you can also stop the connected SAP HANA application, and/or stop the associated EC2 instance where the SAP ABAP and SAP HANA applications are running.
**Note**
You can stop the EC2 instance only if you have selected the option to stop the connected SAP HANA application.
1. Choose **Stop**.
You can monitor the task status using the *operation ID* provided in the flash banner or by choosing the **Operations** tab.
# Run Configuration Checks
Use the following steps to evaluate the SAP configuration of a Systems Manager for SAP application, which is either of type SAP HANA or SAP ABAP.
See also [support restrictions for Systems Manager for SAP](https://docs.aws.amazon.com/ssm-sap/latest/userguide/supported-versions.html).
**Topics**
+ [To access configuration checks](#access-configuration-checks)
+ [To evaluate configuration checks](#evaluate-configuration-checks)
+ [To view and analyze check results](#view-analyze-check-results)
+ [Schedule Configuration Checks using AWS EventBridge Scheduler console](#schedule-configuration-checks-eventbridge)
## To access configuration checks
1. Open the [AWS Console for SAP applications](https://console.aws.amazon.com/awsforsap/home).
1. Choose **Applications**, then choose the SAP application that you want to evaluate.
1. Choose the **SAP configuration checks** tab.
## To evaluate configuration checks
1. Select one or more checks you want to evaluate
1. Choose **Run**
1. Monitor the task status using either the operation ID provided in the notification banner or by choosing **Actions** > **View operations**
## To view and analyze check results
1. Select a single check to view its details
1. Expand individual subchecks to see detailed rules
1. Sort subchecks by Rule Status, Description, or Component
1. Filter results by rule status using the status totals or the filter box
1. Clear filters by selecting the cancel indicator
1. View previous results by selecting a different evaluation date from the dropdown list
1. Access additional information through the provided Documentation links
## Schedule Configuration Checks using AWS EventBridge Scheduler console
1. Sign in to the AWS Management Console, then choose the following link to open the EventBridge Scheduler section of the EventBridge console: https://console.aws.amazon.com/scheduler/home . You can switch your AWS Region by using the AWS Management Console’s Region selector.
1. On the **Schedules** page, choose **Create schedule**.
1. On the **Specify schedule detail** page, in the **Schedule name and description** section, do the following:
1. For **Schedule name**, enter a name for your schedule. For example, `SAPConfigurationChecksSchedule`
1. For **Description - optional**, enter a description for your schedule.
1. For **Schedule group**, choose a schedule group from the drop down options. If you haven’t previously made any schedule groups, you can choose the `default` group for your schedule. To create a new schedule group, choose the **create your own schedule** link in the console description. You use schedule groups to add tags to groups of schedules.
1. In the **Schedule pattern** section, do the following:
1. For **Occurrence**, choose one of the following pattern options. The configuration options change depending on which pattern that you select.
1. **One-time schedule** – A one-time schedule invokes a target only once at the date and time that you specify. For **Date and time**, enter a valid date in `YYYY/MM/DD` format. Then, specify a timestamp in 24-hour `hh:mm` format. Finally, choose a timezone from the drop down options.
1. **Recurring schedule** – A recurring schedule invokes a target at a rate that you specify using a **cron** expression or rate expression. Choose **Cron-based schedule** to configure a schedule by using a **cron** expression. To use a rate expression, choose **Rate-based schedule** and enter a positive number for **Value**, then choose a **Unit** from the drop down options.
For more information on using cron and rate expressions, see [Schedule types in EventBridge Scheduler](https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html).
1. For **Flexible time window**, choose **Off** to turn off the option, or choose one of the pre-defined time windows from the drop down list. For example, if you choose **15 minutes** and you set a recurring schedule to invoke its target once every hour, the schedule runs within 15 minutes after the start of every hour.
1. If you chose **Recurring schedule** in the previous step, in the **Timeframe** section, specify a timezone, and optionally set a start date and time, and an end date and time for the schedule. A recurring schedule without a start date will begin as soon as it is created and available. A recurring schedules without an end date will continue to invoke it’s target indefinitely.
1. Choose **Next**.
1. On the **Select target** page, do the following:
1. Select **All APIs** option, and Find service "Systems Manager for SAP" from the search box.
1. Find the **Target** action "StartConfigurationChecks" and provide the json payload based on the [StartConfigurationChecks API](https://docs.aws.amazon.com/ssmsap/latest/APIReference/API_StartConfigurationChecks.html) action (ApplicationId string input, and optionally, ConfigurationCheckIds array string)
1. Choose **Next**, then on the **Settings - optional** page, follow the steps described in [EventBridge console Getting Started guide](https://docs.aws.amazon.com/scheduler/latest/UserGuide/getting-started.html#getting-started-console) (Step 9 onwards), to change the default settings of the desired schedule.
1. In the Permissions section, in order for the Scheduler to execute the StartConfigurationCheck operation successfully, an IAM role needs to be created with the AWSSystemsManagerForSAPFullAccess managed policy, using the steps below:
1. In the AWS IAM Console, Create a new role, using a “Custom trust Policy“, and the following trust relationship:
```
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"Service": "scheduler.amazonaws.com"
},
"Action": "sts:AssumeRole"
}
]
}
```
1. On the Next page, Add Permissions by searching for and selecting the AWSSystemsManagerForSAPFullAccess managed policy
1. Next, provide the Role name and Description, (and tags if any), before creating the role for the scheduler.
1. Select this new Role in the Permissions section of the schedule on the AWS EventBridge Console, while creating the schedule
1. Choose **Create schedule** to finish creating your new schedule. You can view a list of your new and existing schedules on the **Schedules** page. Under the **Status** column, verify that your new schedule is **Enabled**.
1. To verify that your schedule invokes the Systems Manager for SAP service’s StartConfigurationChecks target, follow the steps listed at [To view and analyze check results](#view-analyze-check-results).