bepri.macos_tools.install (1.0.3) — module

Installer for MacOS PKG files

| "added in version" 1.0.2 of bepri.macos_tools"

Authors: Imani Pelton (@bepri)

Install collection

Install with ansible-galaxy collection install bepri.macos_tools:==1.0.3


Add to requirements.yml

  collections:
    - name: bepri.macos_tools
      version: 1.0.3

Description

This module can install or uninstall PKG files with support for DMG files.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Install directly from a PKG
- name: Install latest version of Google Chrome
  macos_pkg:
    source: "/Volumes/Remote Fileshare/ChromeInstaller.pkg"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Install from a URL
- name: Install latest version of Google Chrome
  macos_pkg:
    source: "https://dl.google.com/dl/chrome/mac/universal/stable/gcem/GoogleChrome.pkg"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Install from a DMG
- name: Install latest version of Google Chrome
  macos_pkg:
    source: "/Volumes/Remote Fileshare/ChromeInstaller.dmg"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Specify the filetype for an installer with no extension
- name: Install latest version of Mysterious Software
  macos_pkg:
    source: "/Volumes/Remote Fileshare/PeculiarInstaller"
    type: dmg
    allow_unsigned: True

Inputs

    
type:
    choices:
    - pkg
    - dmg
    description:
    - Explicitly state the filetype of the installer
    - Only necessary in cases where the path or URL of the installer does not have a file
      extension
    type: str

force:
    default: false
    description:
    - Whether or not to overwrite an existing installation
    type: bool

source:
    description:
    - URL or path string pointing to a PKG or DMG file to be installed
    - Note that this module will always only install the first PKG found inside of a DMG
    type: str

upgrade:
    default: true
    description:
    - Whether or not to upgrade an existing installation.
    - MacOS installer packages are highly unstandardized, which can lead to instances
      where a package installer's declared version actually differs from what the software
      will report as its version once installed. To cope with this, this option can be
      set to C(False) to avoid the confusion.
    type: bool

location:
    description:
    - Optionally override the default install location of a PKG with a different path.
    type: path

allow_untrusted:
    default: false
    description:
    - Whether or not to allow unsigned or otherwise untrusted packages to be installed
    type: bool

Outputs

version_installed:
  description: The version of the package installed
  returned: success
  sample: 7.22.3rev1
  type: str