Skip to content

Commit

Permalink
Merge pull request #706 from HarisDotParis/main
Browse files Browse the repository at this point in the history
robin-checkmk authored Jan 6, 2025

Verified

This commit was signed with the committer’s verified signature.
zner0L Lorenz Sieben
2 parents f6d5ccc + 159060e commit bfdb9b4
Showing 2 changed files with 5 additions and 2 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
@@ -123,6 +125,7 @@ This ensures, that you always know, which module is at play.
sites:
- "mysite"
```
## Getting Involved
See [CONTRIBUTING](CONTRIBUTING.md).
4 changes: 2 additions & 2 deletions plugins/doc_fragments/common.py
Original file line number Diff line number Diff line change
@@ -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:

0 comments on commit bfdb9b4

Please sign in to comment.