cdillc.splunk.splunk_facts (0.26.1) — module

Install collection

Install with ansible-galaxy collection install cdillc.splunk:==0.26.1

Add to requirements.yml

  collections:
    - name: cdillc.splunk
      version: 0.26.1

Description

This module collects various pieces of data about a Splunk installation.

Splunk apps data collection.

Inputs

    
ksconf:
    choices:
    - skip
    - short
    - detail
    default: short
    description:
    - Set the level of ksconf detail to collect.
    - Use I(skip) to disable all ksconf related facts, I(short) to collect basic information,
      and I(detail) to show information about the available subcommands.
    required: false
    type: str

app_dirs:
    default:
    - apps
    - deployment-apps
    - shcluster/apps
    - manager-apps
    - peer-apps
    - master-apps
    - slave-apps
    description:
    - List of paths (relative to I($SPLUNK_HOME/etc)).
    - And absolute path can be provided to check a specific path.
    elements: str
    required: false
    type: list

splunk_home:
    default: null
    description:
    - Path to Splunk installation path. If not provided, this module will check the $SPLUNK_HOME
      environment variable and then several commonly used install paths.
    required: false
    type: path

Outputs

ansible_facts:
  contains:
    ansible_splunk_app_root_missing:
      description:
      - App paths that were inaccessible and therefore are not listed in I(ansible_splunk_apps).
      elements: str
      type: list
    ansible_splunk_apps:
      contains:
        app_conf:
          contains:
            author:
              returned: always
              type: str
            build:
              type: int
            check_for_updates:
              type: bool
            description:
              description: Longer description contained with the app. (This is not
                typically shown anywhere in the UI)
              type: str
            is_visible:
              description: Is the app visible in the user interface
              type: bool
            label:
              description: Display name
              type: str
            state:
              type: str
            version:
              returned: always
              type: str
          description:
          - Configuration information extracted from C(app.conf).
          - Only attributes present will be returned, unless otherwise noted.
          - Data types noted below are based on normal app conventions. However, if
            the app provides unexpected values (like a non-integer C(build)), that
            value is passed along as-is and therefore may be of another type.
          returned: always
          type: dict
        name:
          description: Folder name of the Splunk app
          returned: always
          type: str
        path:
          description: Full path to Splunk application.  This will uniquely identify
            an app.
          returned: always
          type: str
        root:
          description: app location prefix (based on the given value of I(app_dirs))
          returned: always
          sample: deployment-apps
          type: str
        sideload:
          contains:
            ansible_module_version:
              type: str
            installed_at:
              type: str
            src_hash:
              type: str
            src_path:
              type: str
          description:
          - Data loaded is dependent upon the version of ksconf and the sideload module.
          returned: Only present if the app was installed via I(ksconf_sideload_app)
            module.
          type: dict
      description:
      - A list of Splunk apps found.
      - Collection is restricted to the given set of apps in one of the provided I(app_dirs).
      elements: dict
      type: list
    ansible_splunk_config:
      description: splunk configs
      sample:
        <config>:
          <stanza>:
            <key>: value
      type: dict
    ansible_splunk_dist_search:
      description: distributed search public key
    ansible_splunk_ksconf:
      contains:
        build:
          type: int
        commands:
          contains:
            <command>:
              contains:
                class:
                  description: class name
                  type: str
                distro:
                  type: str
                error:
                  description:
                  - Any errors related to specific ksconf commands.
                  - This can happen for example if some Python modules are missing
                    such as I(lxml) or I(splunksdk).
                  returned: on error
                  type: str
              description:
              - The key I(<command>) is dynamically set for each sub-command of the
                ksconf tool.
              sample: xml-format
              type: dict
          type: dict
        package:
          type: str
        path:
          type: str
        vcs_info:
          type: str
        version:
          type: str
      description: ksconf version information
      returned: when requested
      type: dict
    ansible_splunk_launch:
      contains:
        PYTHONHTTPSVERIFY:
          type: str
        SPLUNK_DB:
          description: Default path to splunk indexes.
          type: str
        SPLUNK_OS_USER:
          description: Name of the user Splunk runs as.
          type: str
        SPLUNK_SERVER_NAME:
          description: Local server's name.  Popular values include C(Splunkd) and
            C(SplunkForwarder)
          type: str
      description:
      - Splunk's startup configuration files located in C(splunk-launch.conf).
      - The exact keys located here will vary based on which settings are present.
        Contents shown here are based on popular settings.
      type: dict
    ansible_splunk_swid:
      contains:
        name:
          description:
          - Software name.  Examples include C(Splunk Enterprise) and C(UniversalForwarder).
          sample: UniversalForwarder
          type: str
        patch:
          type: str
        version:
          type: str
      description: Software id tags
      type: dict
    ansible_splunk_version:
      contains:
        build:
          type: int
        platform:
          type: str
        product:
          type: str
        version:
          sample: 9.0.4
      description: 'Version of the Splunk software found

        '
      returned: always
      type: dict
    server_public_key:
      description: public key for splunkd
  description: Splunk facts
  type: dict