community.general.homebrew_cask module – Install and uninstall homebrew casks
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.homebrew_cask
.
Synopsis
Manages Homebrew casks.
Aliases: packaging.os.homebrew_cask
Parameters
Parameter |
Comments |
---|---|
Allow external apps. Choices:
|
|
Upgrade casks that auto update. Passes Choices:
|
|
Options flags to install a package. |
|
Name of cask to install or remove. |
|
‘:’ separated list of paths to search for ‘brew’ executable. Default: |
|
State of the cask. Choices:
|
|
The sudo password to be passed to SUDO_ASKPASS. |
|
Update homebrew itself first. Note that Choices:
|
|
Upgrade all casks. Mutually exclusive with Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Install cask
community.general.homebrew_cask:
name: alfred
state: present
- name: Remove cask
community.general.homebrew_cask:
name: alfred
state: absent
- name: Install cask with install options
community.general.homebrew_cask:
name: alfred
state: present
install_options: 'appdir=/Applications'
- name: Install cask with install options
community.general.homebrew_cask:
name: alfred
state: present
install_options: 'debug,appdir=/Applications'
- name: Install cask with force option
community.general.homebrew_cask:
name: alfred
state: present
install_options: force
- name: Allow external app
community.general.homebrew_cask:
name: alfred
state: present
accept_external_apps: true
- name: Remove cask with force option
community.general.homebrew_cask:
name: alfred
state: absent
install_options: force
- name: Upgrade all casks
community.general.homebrew_cask:
upgrade_all: true
- name: Upgrade all casks with greedy option
community.general.homebrew_cask:
upgrade_all: true
greedy: true
- name: Upgrade given cask with force option
community.general.homebrew_cask:
name: alfred
state: upgraded
install_options: force
- name: Upgrade cask with greedy option
community.general.homebrew_cask:
name: 1password
state: upgraded
greedy: true
- name: Using sudo password for installing cask
community.general.homebrew_cask:
name: wireshark
state: present
sudo_password: "{{ ansible_become_pass }}"