Class: Ansible::Ruby::Modules::Osx_defaults

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/system/osx_defaults.rb

Overview

osx_defaults allows users to read, write, and delete Mac OS X user defaults from Ansible scripts. Mac OS X applications and other programs use the defaults system to record user preferences and other information that must be maintained when the applications aren’t running (such as default font for new documents, or the position of an Info panel).

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#array_add ⇒ Boolean?

Returns Add new elements to the array for a key which has an array as its value.

Returns:

  • (Boolean, nil) —

    Add new elements to the array for a key which has an array as its value.



27
 
# File 'lib/ansible/ruby/modules/generated/extras/system/osx_defaults.rb', line 27

attribute :array_add

#domain ⇒ String?

Returns The domain is a domain name of the form com.companyname.appname.

Returns:

  • (String, nil) —

    The domain is a domain name of the form com.companyname.appname.



11
 
# File 'lib/ansible/ruby/modules/generated/extras/system/osx_defaults.rb', line 11

attribute :domain

#host ⇒ String?

Returns The host on which the preference should apply. The special value “currentHost” corresponds to the “-currentHost” switch of the defaults commandline tool.

Returns:

  • (String, nil) —

    The host on which the preference should apply. The special value “currentHost” corresponds to the “-currentHost” switch of the defaults commandline tool.



15
 
# File 'lib/ansible/ruby/modules/generated/extras/system/osx_defaults.rb', line 15

attribute :host

#key ⇒ String

Returns The key of the user preference.

Returns:

  • (String) —

    The key of the user preference



19
 
# File 'lib/ansible/ruby/modules/generated/extras/system/osx_defaults.rb', line 19

attribute :key

#state ⇒ :present, ...

Returns The state of the user defaults.

Returns:

  • (:present, :absent, nil) —

    The state of the user defaults



35
 
# File 'lib/ansible/ruby/modules/generated/extras/system/osx_defaults.rb', line 35

attribute :state

#type ⇒ :array, ...

Returns The type of value to write.

Returns:

  • (:array, :bool, :boolean, :date, :float, :int, :integer, :string, nil) —

    The type of value to write.



23
 
# File 'lib/ansible/ruby/modules/generated/extras/system/osx_defaults.rb', line 23

attribute :type

#value ⇒ Array<String>, ...

Returns The value to write. Only required when state = present.

Returns:

  • (Array<String>, String, nil) —

    The value to write. Only required when state = present.



31
 
# File 'lib/ansible/ruby/modules/generated/extras/system/osx_defaults.rb', line 31

attribute :value