community.general.osx_defaults module – Manage macOS user defaults
Note
This module is part of the community.general collection (version 5.8.3).
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:
|
|
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 state=present. |
Notes
Note
Apple Mac caches defaults. You may need to logout and login to apply the changes.
Examples
# TODO: Describe what happens in each example
- community.general.osx_defaults:
domain: com.apple.Safari
key: IncludeInternalDebugMenu
type: bool
value: true
state: present
- community.general.osx_defaults:
domain: NSGlobalDomain
key: AppleMeasurementUnits
type: string
value: Centimeters
state: present
- community.general.osx_defaults:
domain: /Library/Preferences/com.apple.SoftwareUpdate
key: AutomaticCheckEnabled
type: int
value: 1
become: true
- community.general.osx_defaults:
domain: com.apple.screensaver
host: currentHost
key: showClock
type: int
value: 1
- community.general.osx_defaults:
key: AppleMeasurementUnits
type: string
value: Centimeters
- community.general.osx_defaults:
key: AppleLanguages
type: array
value:
- en
- nl
- community.general.osx_defaults:
domain: com.geekchimp.macable
key: ExampleKeyToRemove
state: absent
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication