W3cubDocs

/Ansible

homebrew_cask - Install/uninstall homebrew casks.

New in version 1.6.

Synopsis

  • Manages Homebrew casks.

Requirements (on host that executes module)

  • python >= 2.6

Options

parameter required default choices comments
install_options
(added in 2.2)
no
options flags to install a package
aliases: options
name
yes
name of cask to install/remove
aliases: pkg, package, cask
path
no /usr/local/bin
':' separated list of paths to search for 'brew' executable.
state
no present
  • present
  • absent
state of the cask
update_homebrew
(added in 2.2)
no
  • yes
  • no
update homebrew itself first. Note that brew cask update is a synonym for brew update.
aliases: update-brew

Examples

- homebrew_cask:
    name: alfred
    state: present

- homebrew_cask:
    name: alfred
    state: absent

- homebrew_cask:
    name: alfred
    state: present
    install_options: 'appdir=/Applications'

- homebrew_cask:
    name: alfred
    state: present
    install_options: 'debug,appdir=/Applications'

- homebrew_cask:
    name: alfred
    state: absent
    install_options: force

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/homebrew_cask_module.html