All Products
Search
Document Center

CloudOps Orchestration Service:ACS-ESS-LifeCycleInstallAAS

Last Updated:Dec 25, 2025

Template name

ACS-ESS-LifeCycleInstallAAS uses lifecycle hooks to install AAS on instances.

Execute Now

Template description

Uses a lifecycle hook to install additional application servers (AASs) in Elastic Compute Service (ECS) instances.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter

Description

Type

Required

Default value

Limit

PASIP

The private IP address of the primary application server (PAS).

String

Yes

rootPassword

The password of the root user of the PAS.

String

Yes

SAPSID

The system ID (SID) of the AS ABAP-based Systems, Applications, and Products in Data Processing (SAP) system.

String

Yes

userName

The username of the SAP system.

String

Yes

userPassword

The user password of the SAP system.

String

Yes

clientNumber

SAP client

String

Yes

className

The name of the SMLG logon group.

String

No

SPACE

instanceIds

The IDs of the ECS instances.

List

No

['${instanceIds}']

lifecycleHookId

The lifecycle hook ID.

String

No

${lifecycleHookId}

lifecycleActionToken

The token of a specific scaling activity that is associated with the instances.

String

No

${lifecycleActionToken}

OOSAssumeRole

The Resource Access Management (RAM) role that is assumed by CloudOps Orchestration Service (OOS).

String

No

OOSServiceRole

Output parameters

Parameter

Description

Type

commandOutputs

List

Policy that is required to execute the template

{
    "Version": "1",
    "Statement": [
        {
            "Action": [
                "ecs:DescribeInvocationResults",
                "ecs:DescribeInvocations",
                "ecs:RunCommand"
            ],
            "Resource": "*",
            "Effect": "Allow"
        },
        {
            "Action": [
                "ess:CompleteLifecycleAction"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

Details

ACS-ESS-LifeCycleInstallAAS

Template content

FormatVersion: OOS-2019-06-01
Description:
  en: Uses a lifecycle hook to install an additional application server (AAS) in an instance during a scaling activity.
  zh-cn: 使用生命周期挂钩在实例中安装AAS(Additional application server)
  name-en: Installs an AAS in an Instance by Using a Lifecycle Hook
  name-zh-cn: 使用生命周期挂钩在实例中安装AAS
  categories:
    - elastic_manage
Parameters:
  PASIP:
    Label:
      en: PAS Private IP Address
      zh-cn: PAS私网IP地址
    Description:
      en: The private IP address of the ECS instance where the PAS of the SAP AS ABAP system is located.
      zh-cn: SAP AS ABAP系统PAS所在ECS的私网IP地址
    Type: String
  rootPassword:
    Label:
      en: PAS Root Password
      zh-cn: PAS root用户密码
    Description:
      en: The password of the root user for the PAS.
      zh-cn: PAS root用户密码
    Type: String
  SAPSID:
    Label:
      en: SAP AS ABAP System ID
      zh-cn: SAP AS ABAP系统的SID
    Description:
      en: The system ID (SID) of the SAP AS ABAP system.
      zh-cn: SAP AS ABAP系统的SID
    Type: String
  userName:
    Label:
      en: SAP System Username
      zh-cn: SAP系统用户名
    Description:
      en: The username to log on to the SAP GUI for the SAP AS ABAP system.
      zh-cn: SAP AS ABAP系统SAP GUI的登陆用户名
    Type: String
  userPassword:
    Label:
      en: SAP System User Password
      zh-cn: SAP系统用户密码
    Description:
      en: The password for the user to log on to the SAP GUI for the SAP AS ABAP system.
      zh-cn: SAP AS ABAP系统SAP GUI的登陆用户密码
    Type: String
  clientNumber:
    Label:
      en: SAP Client
      zh-cn: SAP CLIENT
    Description:
      en: The client number to log on to the SAP GUI, such as 800 or 600.
      zh-cn: SAP GUI的登陆Client,如800、600
    Type: String
  className:
    Label:
      en: SMLG Logon Group Name
      zh-cn: SMLG登陆组名
    Description:
      en: The name of the SMLG logon group. The scaled-out AAS is automatically added to this logon group. If you leave this parameter empty, the AAS is added to the default group named SPACE.
      zh-cn: SMLG登录组名。扩展出来的AAS将自动加入到SMLG登陆组中,如果不填写,则会自动加入到默认的'SPACE'组中
    Type: String
    Default: SPACE
  instanceIds:
    Label:
      en: ECS Instance IDs
      zh-cn: ECS实例ID列表
    Description:
      en: The IDs of the ECS instances. Use the default value ["${instanceId}"] provided by Auto Scaling.
      zh-cn: ECS实例ID列表,请使用弹性伸缩系统默认值 ["${instanceId}"]
    Type: List
    Default:
      - ${instanceIds}
  lifecycleHookId:
    Label:
      en: Lifecycle Hook ID
      zh-cn: 生命周期挂钩ID
    Description:
      en: The ID of the lifecycle hook. Use the default value ${lifecycleHookId} provided by Auto Scaling.
      zh-cn: 生命周期挂钩ID,请使用弹性伸缩系统默认值 ${lifecycleHookId}
    Type: String
    Default: ${lifecycleHookId}
  lifecycleActionToken:
    Label:
      en: Lifecycle Action Token
      zh-cn: 实例关联的特定伸缩活动的令牌
    Description:
      en: The token of the scaling activity associated with the instance. Use the default value ${lifecycleActionToken} provided by Auto Scaling.
      zh-cn: 实例关联的特定伸缩活动的令牌,请使用弹性伸缩系统默认值 ${lifecycleActionToken}
    Type: String
    Default: ${lifecycleActionToken}
  OOSAssumeRole:
    Label:
      en: RAM Role for OOS
      zh-cn: OOS扮演的RAM角色
    Type: String
    Default: OOSServiceRole
RamRole: '{{ OOSAssumeRole }}'
Tasks:
  - Name: UpdateAliyunAssist
    Action: ACS::ECS::RunCommand
    OnError: runCommand
    Description:
      en: Updates Cloud Assistant.
      zh-cn: 更新云助手
    Properties:
      regionId: '{{ ACS::RegionId }}'
      commandContent: 'rpm -ivh --force "https://aliyun-client-assist-{{ ACS::RegionId }}.oss-{{ ACS::RegionId }}-internal.aliyuncs.com/linux/aliyun_assist_latest.rpm"'
      instanceId: '{{ ACS::TaskLoopItem }}'
      commandType: RunShellScript
    Loop:
      RateControl:
        Mode: Concurrency
        MaxErrors: 0
        Concurrency: 10
      Items: '{{ instanceIds }}'
      Outputs:
        commandOutputs:
          AggregateType: Fn::ListJoin
          AggregateField: commandOutput
    Outputs:
      commandOutput:
        Type: String
        ValueSelector: invocationOutput
  - Name: runCommand
    Action: ACS::ECS::RunCommand
    OnError: CompleteLifecycleActionForAbandon
    OnSuccess: CompleteLifecycleActionForContinue
    Description:
      en: Executes the installation script.
      zh-cn: 执行安装脚本
    Properties:
      regionId: '{{ ACS::RegionId }}'
      commandContent: 'mkdir -p /tmp/sap-auto-scaling && cd /tmp/sap-auto-scaling; wget -q https://sh-test-hangzhou.oss-cn-hangzhou.aliyuncs.com/sap-utilities/sap-auto-scaling/sap_auto_scaling.sh -O /tmp/sap-auto-scaling/sap_auto_scaling.sh && bash sap_auto_scaling.sh --UsrsapDiskName vdb --SwapDiskName vdc --PASIP {{ PASIP }} --RootPassword {{ rootPassword }} --SID {{ SAPSID }} --UserName {{ userName }} --UserPassword {{ userPassword }}  --ClientNumber {{ clientNumber }} --ClassName {{ className }}'
      instanceId: '{{ ACS::TaskLoopItem }}'
      commandType: 'RunShellScript'
      enableParameter: true
    Loop:
      RateControl:
        Mode: Concurrency
        MaxErrors: 0
        Concurrency: 10
      Items: '{{ instanceIds }}'
      Outputs:
        commandOutputs:
          AggregateType: Fn::ListJoin
          AggregateField: commandOutput
    Outputs:
      commandOutput:
        Type: String
        ValueSelector: invocationOutput
  - Name: CompleteLifecycleActionForContinue
    Action: ACS::ExecuteAPI
    Description:
      en: Sets the lifecycle action result to CONTINUE.
      zh-cn: 修改伸缩活动的等待状态为继续完成
    OnSuccess: ACS::END
    Properties:
      Service: ESS
      API: CompleteLifecycleAction
      Parameters:
        RegionId: '{{ ACS::RegionId }}'
        LifecycleHookId: '{{ lifecycleHookId }}'
        LifecycleActionToken: '{{ lifecycleActionToken }}'
        LifecycleActionResult: CONTINUE
  - Name: CompleteLifecycleActionForAbandon
    Action: ACS::ExecuteAPI
    Description:
      en: Sets the lifecycle action result to ABANDON.
      zh-cn: 修改伸缩活动的等待状态为弃用
    Properties:
      Service: ESS
      API: CompleteLifecycleAction
      Parameters:
        RegionId: '{{ ACS::RegionId }}'
        LifecycleHookId: '{{ lifecycleHookId }}'
        LifecycleActionToken: '{{ lifecycleActionToken }}'
        LifecycleActionResult: ABANDON
Outputs:
  commandOutputs:
    Type: List
    Value: '{{ runCommand.commandOutputs }}'