cdillc / cdillc.splunk / 0.24.2 / module / ksconf_app_sideload Unpacks a Splunk app archive after copying it from the controller machine | "added in version" 0.10.0 of cdillc.splunk" Authors: Lowell C. Alleman (@lowell80) This plugin has a corresponding action plugin.cdillc.splunk.ksconf_app_sideload (0.24.2) — module
Install with ansible-galaxy collection install cdillc.splunk:==0.24.2
collections: - name: cdillc.splunk version: 0.24.2
By default, it will copy the source file from the local system to the target before unpacking.
For Windows targets, switch to Linux.
src: description: - Local path to Splunk archive file to copy to the target server; can be absolute or relative. required: true type: path dest: description: - Remote absolute path where the archive should be unpacked. - Typically this will be C(/opt/splunk/etc/apps) or a management folder like C(deployment-apps), C(manager-apps) (or C(master-apps) pre Splunk 9.0), or C(shcluster/apps). required: true type: path mode: description: - The permissions the resulting filesystem object should have. - For those used to I(/usr/bin/chmod) remember that modes are actually octal numbers. You must give Ansible enough information to parse them correctly. For consistent results, quote octal numbers (for example, V('644') or V('1777')) so Ansible receives a string and can do its own conversion from string into number. Adding a leading zero (for example, V(0755)) works sometimes, but can fail in loops and some other circumstances. - Giving Ansible a number without following either of these rules will end up with a decimal number which will have unexpected results. - As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, V(u+rwx) or V(u=rw,g=r,o=r)). - If O(mode) is not specified and the destination filesystem object B(does not) exist, the default C(umask) on the system will be used when setting the mode for the newly created filesystem object. - If O(mode) is not specified and the destination filesystem object B(does) exist, the mode of the existing filesystem object will be used. - Specifying O(mode) is the best way to ensure filesystem objects are created with the correct permissions. See CVE-2020-1736 for further details. type: raw group: description: - Name of the group that should own the filesystem object, as would be fed to I(chown). - When left unspecified, it uses the current group of the current user unless you are root, in which case it can preserve the previous ownership. type: str owner: description: - Name of the user that should own the filesystem object, as would be fed to I(chown). - When left unspecified, it uses the current user unless you are root, in which case it can preserve the previous ownership. - Specifying a numeric username will be assumed to be a user ID and not a username. Avoid numeric usernames to avoid this confusion. type: str serole: description: - The role part of the SELinux filesystem object context. - When set to V(_default), it will use the C(role) portion of the policy if available. type: str setype: description: - The type part of the SELinux filesystem object context. - When set to V(_default), it will use the C(type) portion of the policy if available. type: str seuser: description: - The user part of the SELinux filesystem object context. - By default it uses the V(system) policy, where applicable. - When set to V(_default), it will use the C(user) portion of the policy if available. type: str decrypt: default: true description: - This option controls the autodecryption of source files using vault. type: bool version_added: '2.4' version_added_collection: ansible.builtin selevel: description: - The level part of the SELinux filesystem object context. - This is the MLS/MCS attribute, sometimes known as the C(range). - When set to V(_default), it will use the C(level) portion of the policy if available. type: str attributes: aliases: - attr description: - The attributes the resulting filesystem object should have. - To get supported flags look at the man page for I(chattr) on the target system. - This string should contain the attributes in the same order as the one displayed by I(lsattr). - The C(=) operator is assumed as default, otherwise C(+) or C(-) operators need to be included in the string. type: str version_added: '2.3' version_added_collection: ansible.builtin list_files: default: false description: - If set to True, return the list of files that are contained in the tarball. type: bool version_added: '2.0' version_added_collection: cdillc.splunk state_file: description: - Override the default state file location. The default state file location is nested immediately under the app folder, called C(.ksconf_sideload.json). - Sometimes this may not be ideal when populating C(deployment-apps) where a single change could trigger a burst of traffic, or C(shcluster/apps) where looking at the manifest on the SHC members is always off (because local is merged to default behavior). - Be sure you understand the implications of changing this path. There must be one exactly state file per app per target, otherwise you can anticipate "flapping" between states as app deployment executes. required: false type: path unsafe_writes: default: false description: - Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target filesystem object. - By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target filesystem objects, but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted filesystem objects, which cannot be updated atomically from inside the container and can only be written in an unsafe manner. - This option allows Ansible to fall back to unsafe methods of updating filesystem objects when atomic operations fail (however, it doesn't force Ansible to perform unsafe writes). - IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption. type: bool version_added: '2.2' version_added_collection: ansible.builtin io_buffer_size: default: 65536 description: - Size of the volatile memory buffer that is used for extracting files from the archive in bytes. type: bytes recreate_manifest: default: true description: - Allow remote rebuilding of corrupted or missing manifest state data. - This can be beneficial when upgrading between versions of the collection. But this may not be desirable in all situations. For example, any files not in new app will be removed, which can be problematic if you've intensionally created content within an app (e.g., you've deployed to the 'apps' folder of a running search head and allowed users to create/edit knowledge objects) - When disabled, any app update from earlier versions will simply overwrite the current content, leaving any unknown files as-is. This means that previously deleted content will remain also means that previously delete content will not be removed, as file deletions were not supported prior to manifest support. required: false type: bool
dest: description: Path to the destination directory. returned: always sample: /opt/software type: str files: description: List of all the files in the archive. returned: When I(list_files) is True sample: '["file1", "file2"]' type: list gid: description: Numerical ID of the group that owns the destination directory. returned: always sample: 1000 type: int group: description: Name of the group that owns the destination directory. returned: always sample: librarians type: str mode: description: String that represents the octal permissions of the destination directory. returned: always sample: '0755' type: str owner: description: Name of the user that owns the destination directory. returned: always sample: paul type: str src: description: - The source archive's path. - The location is local to the ansible controller. returned: always sample: /home/paul/test.tar.gz type: str state: description: State of the destination. Effectively always "directory". returned: always sample: directory type: str state_file: description: 'Path to the json state tracking file where installation state, source hash, and application manifest is stored. By default, this is relative to the app install path. ' returned: always sample: fire_brigade/.ksconf_sideload.json type: str uid: description: Numerical ID of the user that owns the destination directory. returned: always sample: 1000 type: int