模板名稱
ACS-ECS-BulkyRunCommand 發送遠程命令
模板描述
批量在多台ECS執行個體上運行雲助手命令,適用於需要同時管理多台ECS執行個體的情境,如應用程式管理和資源標記操作等。在配置過程中,使用者需要提供以下必填參數資訊:地區ID(regionId):用於指定需要執行命令的目標ECS執行個體所在的地區,資源類型(resourceType):用於確定目標ECS執行個體的類型(如ECS執行個體或受管執行個體),目標執行個體(targets):用於選擇要操作的具體執行個體列表。參數還包括命令類型(commandType):指定要執行的命令類型(如Shell指令碼、Python指令碼等),以及命令內容(commandContent):具體的命令或指令碼內容。模板在執行後會返回大量操作的輸出結果,方便使用者驗證命令執行的狀態。
模板類型
自動化
所有者
Alibaba Cloud
輸入參數
參數名稱 | 描述 | 類型 | 是否必填 | 預設值 | 約束 |
targets | 目標執行個體 | Json | 是 | ||
commandContent | 命令內容 | String | 是 | 最大長度 : 16384 | |
regionId | 地區ID | String | 否 | {{ ACS::RegionId }} | |
resourceType | 資源類型 | String | 否 | ALIYUN::ECS::Instance | |
commandType | 命令類型 | String | 否 | RunShellScript | |
workingDir | 運行目錄 | String | 否 | “” | |
timeout | 逾時時間 | Number | 否 | 600 | |
enableParameter | 命令中是否包含加密參數或自訂參數 | Boolean | 否 | False | |
username | 執行命令的使用者名稱稱 | String | 否 | “” | |
windowsPasswordName | 在Windows執行個體中執行命令的使用者的密碼名稱 | String | 否 | “” | |
rateControl | 任務執行的並發比率 | Json | 否 | {‘Mode’: ‘Concurrency’, ‘MaxErrors’: 0, ‘Concurrency’: 10} | |
OOSAssumeRole | OOS扮演的RAM角色 | String | 否 | “” |
輸出參數
參數名稱 | 描述 | 類型 |
commandOutputs | List |
執行此模板需要的權限原則
{
"Version": "1",
"Statement": [
{
"Action": [
"ecs:DescribeInstances",
"ecs:DescribeInvocationResults",
"ecs:DescribeInvocations",
"ecs:DescribeManagedInstances",
"ecs:RunCommand"
],
"Resource": "*",
"Effect": "Allow"
}
]
}
詳情
模板內容
FormatVersion: OOS-2019-06-01
Description:
en: 'Bulky run commands on multiple ECS instances, applicable to scenarios that require managing multiple ECS instances simultaneously, such as application management and resource tagging operations. During configuration, users need to provide the following required parameter information: Region ID (regionId), which specifies the region of the target ECS instances where the commands will be executed, Resource Type (resourceType), to determine the type of target ECS instances (e.g., ECS instance or managed instance), and Target Instances (targets), to select the specific instances to be operated on. Other parameters include Command Type (commandType), which specifies the type of command to be executed (e.g., Shell script, Python script, etc.), and Command Content (commandContent), which is the actual command or script. Upon execution, the template provides the output results of the bulk operation, enabling users to verify the status of the command executions.'
zh-cn: 批量在多台ECS執行個體上運行雲助手命令,適用於需要同時管理多台ECS執行個體的情境,如應用程式管理和資源標記操作等。在配置過程中,使用者需要提供以下必填參數資訊:地區ID(regionId):用於指定需要執行命令的目標ECS執行個體所在的地區,資源類型(resourceType):用於確定目標ECS執行個體的類型(如ECS執行個體或受管執行個體),目標執行個體(targets):用於選擇要操作的具體執行個體列表。參數還包括命令類型(commandType):指定要執行的命令類型(如Shell指令碼、Python指令碼等),以及命令內容(commandContent):具體的命令或指令碼內容。模板在執行後會返回大量操作的輸出結果,方便使用者驗證命令執行的狀態。
name-en: Run Command
name-zh-cn: 發送遠程命令
categories:
- run_command
- application_manage
- computenest
Parameters:
regionId:
Type: String
Label:
en: RegionId
zh-cn: 地區ID
AssociationProperty: RegionId
Default: '{{ ACS::RegionId }}'
resourceType:
Type: String
Label:
en: ResourceType
zh-cn: 資源類型
AssociationPropertyMetadata:
LocaleKey: TargetResourceType
AllowedValues:
- ALIYUN::ECS::Instance
- ALIYUN::ECS::ManagedInstance
Default: ALIYUN::ECS::Instance
targets:
Type: Json
Label:
en: TargetInstance
zh-cn: 目標執行個體
AssociationProperty: Targets
AssociationPropertyMetadata:
ResourceType: resourceType
RegionId: regionId
Status: Running
commandType:
Label:
en: CommandType
zh-cn: 命令類型
AssociationPropertyMetadata:
LocaleKey: ECSCommandType
Type: String
AllowedValues:
- RunShellScript
- RunPythonScript
- RunPerlScript
- RunBatScript
- RunPowerShellScript
Default: RunShellScript
commandContent:
Label:
en: CommandContent
zh-cn: 命令內容
Type: String
MaxLength: 16384
AssociationProperty: ALIYUN::OOS::Command::CommandContent
AssociationPropertyMetadata:
CommandType: ${commandType}
workingDir:
Description:
en: 'Linux instances: under the home directory of the administrator (root user): /root.Windows instances: under the directory where the process of the Cloud Assistant client is located, such asC:\Windows\System32. Please ensure you input the correct directory.'
zh-cn: Linux系統執行個體預設在管理員(root使用者)的home目錄下,即/root。Windows系統執行個體預設在雲助手用戶端進程所在目錄,例如C:\Windows\System32。請確保您輸入的目錄是正確的。'
Label:
en: WorkingDir
zh-cn: 運行目錄
Type: String
Default: ''
AssociationPropertyMetadata:
Value:
- Condition:
Fn::Or:
- Fn::Equals:
- ${commandType}
- RunShellScript
- Fn::Equals:
- ${commandType}
- RunPythonScript
- Fn::Equals:
- ${commandType}
- RunPerlScript
Value: /root
- Condition:
Fn::Or:
- Fn::Equals:
- ${commandType}
- RunBatScript
- Fn::Equals:
- ${commandType}
- RunPowerShellScript
Value: C:\\Windows\\System32
timeout:
Label:
en: Timeout
zh-cn: 逾時時間
Type: Number
Default: 600
enableParameter:
Label:
en: EnableParameter
zh-cn: 命令中是否包含加密參數或自訂參數
Type: Boolean
Default: false
username:
Description:
en: The username that is used to run the command on the ECS instance, length must not exceed 255 characters. Linux system ECS instance, the default is root. Windows system ECS instance, the default is System. Please ensure you input the correct username. <a href="https://www.alibabacloud.com/help/doc-detail/203771.html" target="_blank">See more</a>
zh-cn: 在ECS執行個體中執行命令的使用者名稱稱,長度不得超過255個字元。Linux系統的執行個體,預設以root使用者執行命令。Windows系統的執行個體,預設以System使用者執行命令。請確保您輸入的使用者名稱是正確的。<a href="https://www.alibabacloud.com/help/doc-detail/203771.html" target="_blank">瞭解更多</a>
Label:
en: Username
zh-cn: 執行命令的使用者名稱稱
Type: String
Default: ''
windowsPasswordName:
Label:
en: WindowsPasswordName
zh-cn: 在Windows執行個體中執行命令的使用者的密碼名稱
Type: String
Default: ''
AssociationProperty: ALIYUN::OOS::SecretParameter::Value
AssociationPropertyMetadata:
Visible:
Condition:
Fn::Or:
- Fn::Equals:
- ${commandType}
- RunBatScript
- Fn::Equals:
- ${commandType}
- RunPowerShellScript
rateControl:
Label:
en: RateControl
zh-cn: 任務執行的並發比率
Type: Json
AssociationProperty: RateControl
Default:
Mode: Concurrency
MaxErrors: 0
Concurrency: 10
OOSAssumeRole:
Label:
en: OOSAssumeRole
zh-cn: OOS扮演的RAM角色
Type: String
Default: ''
RamRole: '{{ OOSAssumeRole }}'
Tasks:
- Name: getInstance
Description:
en: Views the ECS instances
zh-cn: 擷取ECS執行個體
Action: ACS::SelectTargets
Properties:
ResourceType: '{{ resourceType }}'
RegionId: '{{ regionId }}'
Filters:
- '{{ targets }}'
Outputs:
instanceIds:
Type: List
ValueSelector: Instances.Instance[].InstanceId
- Name: runCommand
Action: ACS::ECS::RunCommand
Description:
en: Execute cloud assistant command
zh-cn: 執行雲助手命令
Properties:
regionId: '{{ regionId }}'
commandContent: '{{ commandContent }}'
instanceId: '{{ ACS::TaskLoopItem }}'
commandType: '{{ commandType }}'
workingDir: '{{ workingDir }}'
timeout: '{{ timeout }}'
enableParameter: '{{ enableParameter }}'
username: '{{ username }}'
windowsPasswordName: '{{ windowsPasswordName }}'
Loop:
RateControl: '{{ rateControl }}'
Items: '{{ getInstance.instanceIds }}'
Outputs:
commandOutputs:
AggregateType: Fn::ListJoin
AggregateField: commandOutput
Outputs:
commandOutput:
Type: String
ValueSelector: invocationOutput
Outputs:
commandOutputs:
Type: List
Value: '{{ runCommand.commandOutputs }}'
Metadata:
ALIYUN::OOS::Interface:
ParameterGroups:
- Parameters:
- commandType
- commandContent
- workingDir
- timeout
- enableParameter
- username
- windowsPasswordName
Label:
default:
zh-cn: 執行命令選型
en: run command options
- Parameters:
- regionId
- resourceType
- targets
Label:
default:
zh-cn: 選擇執行個體
en: Select Ecs Instances
- Parameters:
- rateControl
- OOSAssumeRole
Label:
default:
zh-cn: 進階選項
en: Control Options