cdillc.splunk.ksconf_app_manifest module – Splunk app manifest (Private)
Note
This module is part of the cdillc.splunk collection (version 0.26.1).
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 cdillc.splunk
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cdillc.splunk.ksconf_app_manifest
.
New in cdillc.splunk 0.22.0
Synopsis
This is used internally by the cdillc.splunk.ksconf_app_sideload. This is not currently intended to be used directly by users.
Requirements
The below requirements are needed on the host that executes this module.
ksconf>=0.11
Parameters
Parameter |
Comments |
---|---|
Path to Splunk application |
|
Discard the auto generated This requires ksconf v0.13.5, or this feature will be ignored. Choices:
|
|
Rebuild the manifest information when missing from or corrupted with the state file. Choices:
|
|
Location of the state file |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in check_mode and return changed status prediction without modifying target |
|
Support: none |
Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode |
|
Platform: posix |
Target OS/families that can be operated against |
Notes
Note
Requires ksconf on the target host.
Examples
- name: Don't do this. This module is not public
cdillc.splunk.ksconf_app_manifest:
app_dir: /opt/splunk/etc/apps/myapp
state_file: /opt/splunk/etc/apps/myapp/.ksconf_sideload.json
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Expanded application directory Returned: always Sample: |
|
Manifest objects. See AppManifest Returned: when manifest is present or built |
|
Final status of the state file. Values include:
Any of the follows indicate a failure:
Returned: always |
|
State of the state file / manifest Returned: on success |
|
Relative path to the json state tracking file where installation state, source hash, and application manifest is stored. Returned: always Sample: |
|
Health indicator of first attempt at reading from present. Expect values such as:
Returned: always |