Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify params server_url & site #706

Merged
merged 10 commits into from
Jan 6, 2025
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,8 @@ We encourage you - in accordance with Ansible Best Practices -
to always use FQCNs (Fully Qualified Collection Names) as seen below.
This ensures, that you always know, which module is at play.

Please keep in mind the parameters `server_url` and `site` are concatenated to form the base URL of the Checkmk site.

```yaml
---
- hosts: all
Expand All @@ -123,6 +125,7 @@ This ensures, that you always know, which module is at play.
sites:
- "mysite"
```

## Getting Involved

See [CONTRIBUTING](CONTRIBUTING.md).
Expand Down
4 changes: 2 additions & 2 deletions plugins/doc_fragments/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ class ModuleDocFragment(object):
DOCUMENTATION = r"""
options:
server_url:
description: The base url of your Checkmk server including the protocol.
description: The base url of your Checkmk server including the protocol but excluding the site.
required: true
type: str
site:
description: The site you want to connect to.
description: The site you want to connect to. This will be appended to the server_url as part of the API request url.
required: true
type: str
automation_user:
Expand Down