FireDaemonService
Service integration of FireDaemon Technologie's Windows Service wrapper
- Overview
- Design
- Constraints
- Attributes
- Commands
- Related Types
Overview
FireDaemonService:
Service integration of FireDaemon Technologie's Windows Service wrapper
Design
- Super Type
- Service
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
| Notification | false |
| Template Directory | |
| Data View | Children, proximity: 1 |
| Logger Name |
Constraints
Allowed Child Dependencies
- FireDaemonExecutable 1
- FireDaemonServiceAccountName 1
- FireDaemonServiceAccountPassword 1
- FireDaemonServiceDescription 1
- FireDaemonServiceDisplayName 1
- FireDaemonServiceExecutable 1
- FireDaemonServiceName 1
- FireDaemonServiceParameters 1
1: These types have a Singleton constraint. Only one instance may be added as a resource.
Allowed Parent Dependencies
- Node
- Site
Attributes
Exported Attributes
| Name | Property |
|---|---|
| installRoot | deployment-install-root |
| workingDir | deployment-basedir |
Defaults for Imported Attributes
| Name | Default |
|---|---|
| fireDaemonExecutable | C:\Program Files\FireDaemon\FireDaemon.exe |
| fireDaemonServiceExecutable | LoginServer.exe |
| fireDaemonServiceParameters |
Commands
Deploy
Run the service deployment cycle, stopping, unconfiguring, installing package dependencies, configuring and the starting the service.
- Usage
- Deploy
Workflow
Update
Run the service deployment cycle, same as Deploy
- Usage
- Update
Workflow
Add
Add the FireDaemon Windows service if it is not already installed.
- Usage
- Add
Workflow
Error Handler
| Command |
Remove
Remove the FireDaemon Windows service if it is installed.
- Usage
- Remove
Workflow
Error Handler
| Command |
addService
Add the FireDaemon Windows service to the system
- Usage
- addService [-firedaemon <>]
Options
| Option | Description |
|---|---|
| firedaemon | Location of the FireDaemon executable |
removeService
Remove the FireDaemon Windows service from the system
- Usage
- removeService [-firedaemon <>] [-servicename <>]
Options
| Option | Description |
|---|---|
| firedaemon | Location of the FireDaemon executable |
| servicename | FireDaemon Windows service name |
assertServiceIsUp
Check whether the FireDaemon Windows service is up
- Usage
- assertServiceIsUp [-firedaemon <>] [-servicename <>]
Options
| Option | Description |
|---|---|
| firedaemon | Location of the FireDaemon executable |
| servicename | FireDaemon Windows service name |
assertServiceIsDown
Check whether the FireDaemon Windows service is down
- Usage
- assertServiceIsDown [-firedaemon <>] [-servicename <>]
Options
| Option | Description |
|---|---|
| firedaemon | Location of the FireDaemon executable |
| servicename | FireDaemon Windows service name |
assertServiceIsInstalled
Check whether the FireDaemon Windows service is installed
- Usage
- assertServiceIsInstalled [-firedaemon <>] [-servicename <>]
Options
| Option | Description |
|---|---|
| firedaemon | Location of the FireDaemon executable |
| servicename | FireDaemon Windows service name |
assertServiceIsNotInstalled
Check whether the FireDaemon Windows service is not installed
- Usage
- assertServiceIsNotInstalled [-firedaemon <>] [-servicename <>]
Options
| Option | Description |
|---|---|
| firedaemon | Location of the FireDaemon executable |
| servicename | FireDaemon Windows service name |
startService
Start the FireDaemon Windows service
- Usage
- startService [-firedaemon <>] [-servicename <>]
Options
| Option | Description |
|---|---|
| firedaemon | Location of the FireDaemon executable |
| servicename | FireDaemon Windows service name |
stopService
Stop the FireDaemon Windows service
- Usage
- stopService [-firedaemon <>] [-servicename <>]
Options
| Option | Description |
|---|---|
| firedaemon | Location of the FireDaemon executable |
| servicename | FireDaemon Windows service name |
Related Types
The following types are defined for use with FireDaemonService.
FireDaemonServiceSetting
Overview
FireDaemonServiceSetting:
FireDaemon configuration setting
Design
- Super Type
- Setting
| Role | Abstract. (Objects cannot be created.) |
| Instance Names | Unique |
FireDaemonExecutable
Overview
FireDaemonExecutable:
Location of the FireDaemon command-line executable
Design
- Super Type
- FireDaemonServiceSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| fireDaemonExecutable | settingValue |
FireDaemonServiceName
Overview
FireDaemonServiceName:
Name of the FireDaemon Windows service
Design
- Super Type
- FireDaemonServiceSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| fireDaemonServiceName | settingValue |
FireDaemonServiceDisplayName
Overview
FireDaemonServiceDisplayName:
Displayed name of the FireDaemon Windows service
Design
- Super Type
- FireDaemonServiceSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| fireDaemonServiceDisplayName | settingValue |
FireDaemonServiceDescription
Overview
FireDaemonServiceDescription:
Description of the FireDaemon Windows service
Design
- Super Type
- FireDaemonServiceSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| fireDaemonServiceDescription | settingValue |
FireDaemonServiceExecutable
Overview
FireDaemonServiceExecutable:
Executable for FireDaemon to run as a Windows service
Design
- Super Type
- FireDaemonServiceSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| fireDaemonServiceExecutable | settingValue |
FireDaemonServiceParameters
Overview
FireDaemonServiceParameters:
Parameters for the windows service via FireDaemon
Design
- Super Type
- FireDaemonServiceSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| fireDaemonServiceParameters | settingValue |
FireDaemonServiceAccountName
Overview
FireDaemonServiceAccountName:
Account name to use with the FireDaemon Windows service.
Design
- Super Type
- FireDaemonServiceSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| fireDaemonServiceAccountName | settingValue |
FireDaemonServiceAccountPassword
Overview
FireDaemonServiceAccountPassword:
Account password to use with the FireDaemon Windows service.
Design
- Super Type
- FireDaemonServiceSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| fireDaemonServiceAccountPassword | settingValue |