Class: Ansible::Ruby::Modules::Win_shortcut

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/windows/win_shortcut.rb

Overview

Create, manage and delete Windows shortcuts

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#args ⇒ String?

Returns Additional arguments for the executable defined in C(src).

Returns:

  • (String, nil) —

    Additional arguments for the executable defined in C(src).



24
 
# File 'lib/ansible/ruby/modules/generated/windows/win_shortcut.rb', line 24

attribute :args

#description ⇒ String?

Returns Description for the shortcut.,This is usually shown when hoovering the icon.

Returns:

  • (String, nil) —

    Description for the shortcut.,This is usually shown when hoovering the icon.



16
 
# File 'lib/ansible/ruby/modules/generated/windows/win_shortcut.rb', line 16

attribute :description

#dest ⇒ String

Returns Destination file for the shortcuting file.,File name should have a C(.lnk) or C(.url) extension.

Returns:

  • (String) —

    Destination file for the shortcuting file.,File name should have a C(.lnk) or C(.url) extension.



20
 
# File 'lib/ansible/ruby/modules/generated/windows/win_shortcut.rb', line 20

attribute :dest

#directory ⇒ String?

Returns Working directory for executable defined in C(src).

Returns:

  • (String, nil) —

    Working directory for executable defined in C(src).



28
 
# File 'lib/ansible/ruby/modules/generated/windows/win_shortcut.rb', line 28

attribute :directory

#hotkey ⇒ String?

Returns Key combination for the shortcut.,This is a combination of one or more modifiers and a key.,Possible modifiers are Alt, Ctrl, Shift, Ext.,Possible keys are [A-Z] and [0-9].

Returns:

  • (String, nil) —

    Key combination for the shortcut.,This is a combination of one or more modifiers and a key.,Possible modifiers are Alt, Ctrl, Shift, Ext.,Possible keys are [A-Z] and [0-9].



36
 
# File 'lib/ansible/ruby/modules/generated/windows/win_shortcut.rb', line 36

attribute :hotkey

#icon ⇒ String?

Returns Icon used for the shortcut.,File name should have a C(.ico) extension.,The file name is followed by a comma and the number in the library file (.dll) or use 0 for an image file.

Returns:

  • (String, nil) —

    Icon used for the shortcut.,File name should have a C(.ico) extension.,The file name is followed by a comma and the number in the library file (.dll) or use 0 for an image file.



32
 
# File 'lib/ansible/ruby/modules/generated/windows/win_shortcut.rb', line 32

attribute :icon

#src ⇒ String?

Returns Executable or URL the shortcut points to.,The executable needs to be in your PATH, or has to be an absolute path to the executable.

Returns:

  • (String, nil) —

    Executable or URL the shortcut points to.,The executable needs to be in your PATH, or has to be an absolute path to the executable.



12
 
# File 'lib/ansible/ruby/modules/generated/windows/win_shortcut.rb', line 12

attribute :src

#state ⇒ :absent, ...

Returns When C(absent), removes the shortcut if it exists.,When C(present), creates or updates the shortcut.

Returns:

  • (:absent, :present, nil) —

    When C(absent), removes the shortcut if it exists.,When C(present), creates or updates the shortcut.



44
 
# File 'lib/ansible/ruby/modules/generated/windows/win_shortcut.rb', line 44

attribute :state

#windowstyle ⇒ :maximized, ...

Returns Influences how the application is displayed when it is launched.

Returns:

  • (:maximized, :minimized, :normal, nil) —

    Influences how the application is displayed when it is launched.



40
 
# File 'lib/ansible/ruby/modules/generated/windows/win_shortcut.rb', line 40

attribute :windowstyle