Github user andreaturli commented on a diff in the pull request:
https://github.com/apache/brooklyn-docs/pull/194#discussion_r120569115
--- Diff: guide/blueprints/effectors.md ---
@@ -0,0 +1,185 @@
+---
+title: Effectors
+layout: website-normal
+---
+
+Effectors perform an operation of some kind, carried out by a Brooklyn
Entity.
+They can be manually invoked or triggered by a [Policy]({{ site.path.guide
}}/blueprints/policies.html).
+
+Common uses of an effector include the following:
+
+* Perform a command on a remote machine.
+* Collect data and publish them to sensors.
+
+Entities have default effectors, the lifecycle management effectors like
`start`, `stop`, `restart`, and clearly more `Effectors` can be attached to
them.
+
+Off-the-Shelf Effectors
+----------------------
+
+Effectors are highly reusable as their inputs, thresholds and targets are
customizable.
+
+### SSHCommandEffector
+
+An `Effector` to invoke a command on a node accessible via SSH.
+
+It enables execution of a `command` in a specific `execution director`
(executionDir) by using a custom `shell environment` (shellEnv).
+By default, the specified command will be executed on the entity where the
effector is attached or on all *children* or all *members* (if it is a group)
by configuring `executionTarget`.
+
+There are a number of additional configuration keys available for the
`SSHCommandEffector`:
+
+| Configuration Key | Default | Description
|
+|-----------------------------------|---------|--------------------------------------------------------------------------------------|
+| command | String | command to be executed on
the execution target |
+| executionDir | String | possible values: 'GET',
'HEAD', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS', 'TRACE' |
+| shellEnv | String | custom shell environment
where the command is executed |
+| executionTarget | ENTITY | possible values: 'MEMBERS',
'CHILDREN' |
--- End diff --
arg, sorry I forgot to push it
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
