ansible.builtin.homebrew_cask (v2.5.11) — module

Install/uninstall homebrew casks.

| "added in version" 1.6 of ansible.builtin"

Authors: Indrajit Raychaudhuri (@indrajitr), Daniel Jaouen (@danieljaouen), Enric Lluelles (@enriclluelles)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.5.11

Description

Manages Homebrew casks.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- homebrew_cask:
    name: alfred
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- homebrew_cask:
    name: alfred
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- homebrew_cask:
    name: alfred
    state: present
    install_options: 'appdir=/Applications'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- homebrew_cask:
    name: alfred
    state: present
    install_options: 'debug,appdir=/Applications'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- homebrew_cask:
    name: alfred
    state: present
    allow_external_apps: True
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- homebrew_cask:
    name: alfred
    state: absent
    install_options: force
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- homebrew_cask:
    upgrade_all: true
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- homebrew_cask:
    name: alfred
    state: upgraded
    install_options: force

Inputs

    
name:
    aliases:
    - pkg
    - package
    - cask
    description:
    - name of cask to install/remove
    required: true

path:
    default: /usr/local/bin
    description:
    - ''':'' separated list of paths to search for ''brew'' executable.'
    required: false

state:
    choices:
    - present
    - absent
    - upgraded
    default: present
    description:
    - state of the cask
    required: false

upgrade:
    default: false
    description:
    - upgrade all casks (mutually exclusive with `upgrade_all`)
    required: false
    version_added: 2.5.0
    version_added_collection: ansible.builtin

upgrade_all:
    default: false
    description:
    - upgrade all casks (mutually exclusive with `upgrade`)
    required: false
    version_added: 2.5.0
    version_added_collection: ansible.builtin

install_options:
    aliases:
    - options
    default: null
    description:
    - options flags to install a package
    required: false
    version_added: '2.2'
    version_added_collection: ansible.builtin

update_homebrew:
    aliases:
    - update-brew
    choices:
    - 'yes'
    - 'no'
    default: false
    description:
    - update homebrew itself first. Note that C(brew cask update) is a synonym for C(brew
      update).
    required: false
    version_added: '2.2'
    version_added_collection: ansible.builtin

accept_external_apps:
    default: false
    description:
    - allow external apps
    required: false
    version_added: 2.5.0
    version_added_collection: ansible.builtin