SystemService
Unix/Linux system service module
Overview
SystemService: Unix/Linux system service module
SystemService uses the /etc/init.d/ scripts to manage services, optionally via sudo.
Design
- Super Type
- Service
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
| Notification | false |
| Template Directory | |
| Data View | Children, proximity: 1 |
| Logger Name | SystemService |
Constraints
Allowed Child Dependencies
- Package
- Service
- SystemServicePidFile 1
- SystemServiceScript 1
- SystemServiceStartEventTimeout 1
- SystemServiceStopEventTimeout 1
- SystemServiceUseSudo 1
1: These types have a Singleton constraint. Only one instance may be added as a resource.
Allowed Parent Dependencies
- Node
- Site
Attributes
Defaults for Imported Attributes
| Name | Default |
|---|---|
| systemServicePidFile | |
| systemServiceStartEventTimeout | 30 |
| systemServiceStopEventTimeout | 30 |
| systemServiceUseSudo | true |
Commands
View the available commands in the User Reference.
Related Types
The following types are defined for use with SystemService.
SystemServicePidFile
Overview
SystemServicePidFile: Identifies the location of the process identifier file to use for service life-cycle management
No type level default value is set in order to preserve backward-compatibility with earlier SystemService sub-types
Design
- Super Type
- SystemServiceSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property |
|---|---|
| systemServicePidFile | settingValue |
SystemServiceScript
Overview
SystemServiceScript: The name of the system service script in /etc/init.d
This must be set in order to use this module directly. You can also set an attribute-default for systemServiceScript in your subtype.
Design
- Super Type
- SystemServiceSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property |
|---|---|
| systemServiceScript | settingValue |
SystemServiceSetting
Overview
SystemServiceSetting: An System Service setting.
Design
- Super Type
- Setting
| Role | Abstract. (Objects cannot be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
SystemServiceStartEventTimeout
Overview
SystemServiceStartEventTimeout: Duration (in seconds) to wait for the start event(s) to occur
Design
- Super Type
- SystemServiceSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| systemServiceStartEventTimeout | settingValue |
SystemServiceStopEventTimeout
Overview
SystemServiceStopEventTimeout: Duration (in seconds) to wait for the stop event(s) to occur
Design
- Super Type
- SystemServiceSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| systemServiceStopEventTimeout | settingValue |
SystemServiceUseSudo
Overview
SystemServiceUseSudo: Indicate whether sudo should be used to run the commands necessary to manage system services
Defaults to true.
Design
- Super Type
- SystemServiceSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Attributes
Exported Attributes
| Name | Property |
|---|---|
| systemServiceUseSudo | settingValue |