community.general.osx_defaults module – Manage macOS user defaults
Note
This module is part of the community.general collection (version 9.5.1).
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.osx_defaults
.
Synopsis
osx_defaults allows users to read, write, and delete macOS user defaults from Ansible scripts.
macOS applications and other programs use the defaults system to record user preferences and other information that must be maintained when the applications are not running (such as default font for new documents, or the position of an Info panel).
Parameters
Parameter |
Comments |
---|---|
Add new elements to the array for a key which has an array as its value. Choices:
|
|
Checks if the type of the provided If the types do not match, raises an error. Choices:
|
|
The domain is a domain name of the form Default: |
|
The host on which the preference should apply. The special value |
|
The key of the user preference. |
|
The path in which to search for Default: |
|
The state of the user defaults. If set to Choices:
|
|
The type of value to write. Choices:
|
|
The value to write. Only required when |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
Apple Mac caches defaults. You may need to logout and login to apply the changes.
Examples
- name: Set boolean valued key for application domain
community.general.osx_defaults:
domain: com.apple.Safari
key: IncludeInternalDebugMenu
type: bool
value: true
state: present
- name: Set string valued key for global domain
community.general.osx_defaults:
domain: NSGlobalDomain
key: AppleMeasurementUnits
type: string
value: Centimeters
state: present
- name: Set int valued key for arbitrary plist
community.general.osx_defaults:
domain: /Library/Preferences/com.apple.SoftwareUpdate
key: AutomaticCheckEnabled
type: int
value: 1
become: true
- name: Set int valued key only for the current host
community.general.osx_defaults:
domain: com.apple.screensaver
host: currentHost
key: showClock
type: int
value: 1
- name: Defaults to global domain and setting value
community.general.osx_defaults:
key: AppleMeasurementUnits
type: string
value: Centimeters
- name: Setting an array valued key
community.general.osx_defaults:
key: AppleLanguages
type: array
value:
- en
- nl
- name: Removing a key
community.general.osx_defaults:
domain: com.geekchimp.macable
key: ExampleKeyToRemove
state: absent