/ home / community / community.windows / 2.2.0 / module / win_shortcut

community.windows.win_shortcut (2.2.0) — module

Manage shortcuts on Windows

Authors: Dag Wieers (@dagwieers)

Install collection

Install with ansible-galaxy collection install community.windows:==2.2.0

Add to requirements.yml

  collections:
    - name: community.windows
      version: 2.2.0

Description

Create, manage and delete Windows shortcuts

Usage examples

Scanned by Steampunk Spotter

- name: Create an application shortcut on the desktop
  community.windows.win_shortcut:
    src: C:\Program Files\Mozilla Firefox\Firefox.exe
    dest: C:\Users\Public\Desktop\Mozilla Firefox.lnk
    icon: C:\Program Files\Mozilla Firefox\Firefox.exe,0

Scanned by Steampunk Spotter

- name: Create the same shortcut using environment variables
  community.windows.win_shortcut:
    description: The Mozilla Firefox web browser
    src: '%ProgramFiles%\Mozilla Firefox\Firefox.exe'
    dest: '%Public%\Desktop\Mozilla Firefox.lnk'
    icon: '%ProgramFiles\Mozilla Firefox\Firefox.exe,0'
    directory: '%ProgramFiles%\Mozilla Firefox'
    hotkey: Ctrl+Alt+F

Scanned by Steampunk Spotter

- name: Create an application shortcut for an executable in PATH to your desktop
  community.windows.win_shortcut:
    src: cmd.exe
    dest: Desktop\Command prompt.lnk

Scanned by Steampunk Spotter

- name: Create an application shortcut for the Ansible website
  community.windows.win_shortcut:
    src: '%ProgramFiles%\Google\Chrome\Application\chrome.exe'
    dest: '%UserProfile%\Desktop\Ansible website.lnk'
    arguments: --new-window https://ansible.com/
    directory: '%ProgramFiles%\Google\Chrome\Application'
    icon: '%ProgramFiles%\Google\Chrome\Application\chrome.exe,0'
    hotkey: Ctrl+Alt+A

Scanned by Steampunk Spotter

- name: Create a URL shortcut for the Ansible website
  community.windows.win_shortcut:
    src: https://ansible.com/
    dest: '%Public%\Desktop\Ansible website.url'

Inputs

    
src:
    description:
    - 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.
    type: str

dest:
    description:
    - Destination file for the shortcuting file.
    - File name should have a C(.lnk) or C(.url) extension.
    required: true
    type: path

icon:
    description:
    - 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.
    type: path

state:
    choices:
    - absent
    - present
    default: present
    description:
    - When C(absent), removes the shortcut if it exists.
    - When C(present), creates or updates the shortcut.
    type: str

hotkey:
    description:
    - 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].
    type: str

arguments:
    aliases:
    - args
    description:
    - Additional arguments for the executable defined in C(src).
    type: str

directory:
    description:
    - Working directory for executable defined in C(src).
    type: path

description:
    description:
    - Description for the shortcut.
    - This is usually shown when hoovering the icon.
    type: str

windowstyle:
    choices:
    - maximized
    - minimized
    - normal
    description:
    - Influences how the application is displayed when it is launched.
    type: str

run_as_admin:
    default: false
    description:
    - When C(src) is an executable, this can control whether the shortcut will be opened
      as an administrator or not.
    type: bool

Install collection

Add to requirements.yml

Description

Usage examples

Inputs

See also