community.general.nginx_status_info module – Retrieve information on nginx status
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.nginx_status_info
.
Synopsis
Gathers information from nginx from an URL having
stub_status
enabled.
Aliases: web_infrastructure.nginx_status_info
Parameters
Parameter |
Comments |
---|---|
HTTP connection timeout in seconds. Default: |
|
URL of the nginx status. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
See http://nginx.org/en/docs/http/ngx_http_stub_status_module.html for more information.
Examples
# Gather status info from nginx on localhost
- name: Get current http stats
community.general.nginx_status_info:
url: http://localhost/nginx_status
register: result
# Gather status info from nginx on localhost with a custom timeout of 20 seconds
- name: Get current http stats
community.general.nginx_status_info:
url: http://localhost/nginx_status
timeout: 20
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The total number of accepted client connections. Returned: success Sample: |
|
Active connections. Returned: success Sample: |
|
HTTP response as is. Returned: success Sample: |
|
The total number of handled connections. Generally, the parameter value is the same as accepts unless some resource limits have been reached. Returned: success Sample: |
|
The current number of connections where nginx is reading the request header. Returned: success Sample: |
|
The total number of client requests. Returned: success Sample: |
|
The current number of idle client connections waiting for a request. Returned: success Sample: |
|
The current number of connections where nginx is writing the response back to the client. Returned: success Sample: |