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

Requirements

The below requirements are needed on the host that executes this module.

  • ksconf>=0.11

Parameters

Parameter

Comments

app_dir

path / required

Path to Splunk application

discard_local_app_autogen

boolean

Discard the auto generated local/app.conf file created by the deployment server.

This requires ksconf v0.13.5, or this feature will be ignored.

Choices:

  • false

  • true ← (default)

rebuild_manifest

boolean

Rebuild the manifest information when missing from or corrupted with the state file.

Choices:

  • false ← (default)

  • true

state_file

path

Location of the state file

Attributes

Attribute

Support

Description

check_mode

Support: none

Can run in check_mode and return changed status prediction without modifying target

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

platform

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

app_dir

string

Expanded application directory

Returned: always

Sample: "/opt/splunk/etc/app/fire_brigade"

manifest

dictionary

Manifest objects. See AppManifest

Returned: when manifest is present or built

result

string

Final status of the state file. Values include:

loaded when state & manifest successfully loaded from state_file,

created when state file was created from scratch,

rebuilt when existing state file was updated with new manifest, or

no-manifest when the manifest could not be loaded and rebuild_manifest is false.

Any of the follows indicate a failure:

no-app when the app_dir is missing,

error when an unexpected error occurred.

Returned: always

state

dictionary

State of the state file / manifest

Returned: on success

state_file

string

Relative path to the json state tracking file where installation state, source hash, and application manifest is stored.

Returned: always

Sample: "/opt/splunk/etc/app/fire_brigade/.ksconf_sideload.json"

state_init

string

Health indicator of first attempt at reading from present.

Expect values such as:

present - state present and includes manifest,

old-version - state present with no manifest,

corrupted - unable to decode json,

missing - no state file present, or

error unexpected error attempting to load state_file.

Returned: always

Authors

  • Lowell C. Alleman (@lowell80)