@@ -4561,144 +4561,6 @@ with:
45614561 name: nginx
45624562` ` `
45634563
4564- # # health
4565-
4566- # ## `health.http`
4567-
4568- Assert HTTP status and optional body content from the controller.
4569-
4570- - Remote session : ` false`
4571- - Dry-run support : ` true`
4572- - Check mode support : ` false`
4573-
4574- | Parameter | Required | Type | Default | Description |
4575- |---|---:|---|---|---|
4576- | `url` | yes | `string` | | HTTP URL. |
4577- | `method` | no | `string` | `GET` | HTTP request method. |
4578- | `headers` | no | `mapping` | | HTTP request headers. |
4579- | `body` | no | `string` | | Raw HTTP request body. |
4580- | `json` | no | `mapping` | | JSON HTTP request body. |
4581- | `timeout` | no | `number` | | Operation timeout in seconds. |
4582- | `encoding` | no | `string` | `utf-8` | Text encoding used for command output, HTTP bodies or file content. |
4583- | `validate_tls` | no | `boolean` | `True` | Validate TLS certificates for HTTPS requests. |
4584- | `expected_status` | no | `integer` | `200` | Expected HTTP status code. |
4585- | `status` | no | `integer` | | Expected HTTP status code alias. |
4586- | `contains` | no | `string` | | Required substring in stdout or HTTP response body. |
4587-
4588- Result fields :
4589-
4590- - `changed` : Whether the plugin changed the target or controller state.
4591- - `message` : Human-readable result message.
4592- - `rc` : Process or command return code when applicable.
4593- - `stdout` : Captured standard output when applicable.
4594- - `stderr` : Captured standard error when applicable.
4595- - `data` : Plugin-specific structured result data.
4596-
4597- Example :
4598-
4599- ` ` ` yaml
4600- use: health.http
4601- with:
4602- url: https://example.invalid/health
4603- ` ` `
4604-
4605- # ## `health.listen`
4606-
4607- Assert that a TCP port is listening on the target.
4608-
4609- - Remote session : ` true`
4610- - Dry-run support : ` true`
4611- - Check mode support : ` false`
4612-
4613- | Parameter | Required | Type | Default | Description |
4614- |---|---:|---|---|---|
4615- | `port` | yes | `integer` | | TCP port number. |
4616- | `host` | no | `string` | | Hostname or IP address to check from the controller. |
4617- | `listen` | no | `boolean` | `True` | Check whether a port is listening on the target. |
4618- | `timeout` | no | `number` | | Operation timeout in seconds. |
4619- | `sudo` | no | `boolean` | `False` | Run the remote operation through sudo -n when supported. |
4620-
4621- Result fields :
4622-
4623- - `changed` : Whether the plugin changed the target or controller state.
4624- - `message` : Human-readable result message.
4625- - `rc` : Process or command return code when applicable.
4626- - `stdout` : Captured standard output when applicable.
4627- - `stderr` : Captured standard error when applicable.
4628- - `data` : Plugin-specific structured result data.
4629-
4630- Example :
4631-
4632- ` ` ` yaml
4633- use: health.listen
4634- with:
4635- port: 22
4636- ` ` `
4637-
4638- # ## `health.port`
4639-
4640- Assert that a TCP port is reachable from the controller or listening on the target.
4641-
4642- - Remote session : ` true`
4643- - Dry-run support : ` true`
4644- - Check mode support : ` false`
4645-
4646- | Parameter | Required | Type | Default | Description |
4647- |---|---:|---|---|---|
4648- | `port` | yes | `integer` | | TCP port number. |
4649- | `host` | no | `string` | | Hostname or IP address to check from the controller. |
4650- | `listen` | no | `boolean` | `True` | Check whether a port is listening on the target. |
4651- | `timeout` | no | `number` | | Operation timeout in seconds. |
4652- | `sudo` | no | `boolean` | `False` | Run the remote operation through sudo -n when supported. |
4653-
4654- Result fields :
4655-
4656- - `changed` : Whether the plugin changed the target or controller state.
4657- - `message` : Human-readable result message.
4658- - `rc` : Process or command return code when applicable.
4659- - `stdout` : Captured standard output when applicable.
4660- - `stderr` : Captured standard error when applicable.
4661- - `data` : Plugin-specific structured result data.
4662-
4663- Example :
4664-
4665- ` ` ` yaml
4666- use: health.port
4667- with:
4668- port: 22
4669- ` ` `
4670-
4671- # ## `health.process`
4672-
4673- Assert that a remote process matching a pattern exists or is absent.
4674-
4675- - Remote session : ` true`
4676- - Dry-run support : ` true`
4677- - Check mode support : ` false`
4678-
4679- | Parameter | Required | Type | Default | Description |
4680- |---|---:|---|---|---|
4681- | `pattern` | yes | `string` | | Regex, process pattern or search pattern. |
4682- | `state` | no | `string` | | Desired state such as present, absent, started or stopped. |
4683- | `sudo` | no | `boolean` | `False` | Run the remote operation through sudo -n when supported. |
4684-
4685- Result fields :
4686-
4687- - `changed` : Whether the plugin changed the target or controller state.
4688- - `message` : Human-readable result message.
4689- - `rc` : Process or command return code when applicable.
4690- - `stdout` : Captured standard output when applicable.
4691- - `stderr` : Captured standard error when applicable.
4692- - `data` : Plugin-specific structured result data.
4693-
4694- Example :
4695-
4696- ` ` ` yaml
4697- use: health.process
4698- with:
4699- pattern: KEY=.*
4700- ` ` `
4701-
47024564# # hostname
47034565
47044566# ## `hostname.set`
0 commit comments