osx_defaults – Manage macOS user defaults
osx_defaults – Manage macOS user defaults
New in version 2.0.
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 | Choices/Defaults | Comments |
---|---|---|
array_add boolean |
|
Add new elements to the array for a key which has an array as its value. |
domain string |
Default: "NSGlobalDomain" |
The domain is a domain name of the form |
host string added in 2.1 |
The host on which the preference should apply. The special value | |
key string / required |
The key of the user preference. | |
path string |
Default: "/usr/bin:/usr/local/bin" |
The path in which to search for |
state string |
|
The state of the user defaults. If set to
|
type string |
|
The type of value to write. |
value raw |
The value to write. Only required when |
Notes
Note
- Apple Mac caches defaults. You may need to logout and login to apply the changes.
Examples
- osx_defaults:
domain: com.apple.Safari
key: IncludeInternalDebugMenu
type: bool
value: true
state: present
- osx_defaults:
domain: NSGlobalDomain
key: AppleMeasurementUnits
type: string
value: Centimeters
state: present
- osx_defaults:
domain: com.apple.screensaver
host: currentHost
key: showClock
type: int
value: 1
- osx_defaults:
key: AppleMeasurementUnits
type: string
value: Centimeters
- osx_defaults:
key: AppleLanguages
type: array
value:
- en
- nl
- osx_defaults:
domain: com.geekchimp.macable
key: ExampleKeyToRemove
state: absent
Status
- This module is guaranteed to have no backward incompatible interface changes going forward. [stableinterface]
- This module is maintained by the Ansible Community. [community]
Authors
- Franck Nijhof (@frenck)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/osx_defaults_module.html