community.windows.win_feature_info (2.2.0) — module

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

Gather information about all or a specific installed Windows feature(s).

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get info for all installed features
  community.windows.win_feature_info:
  register: feature_info

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get info for a single feature
  community.windows.win_feature_info:
    name: DNS
  register: feature_info

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Find all features that start with 'FS'
  ansible.windows.win_feature_info:
    name: FS*

Inputs

    
name:
    default: '*'
    description:
    - If specified, this is used to match the C(name) of the Windows feature to get the
      info for.
    - Can be a wildcard to match multiple features but the wildcard will only be matched
      on the C(name) of the feature.
    - If omitted then all features will returned.
    type: str

Outputs

exists:
  description: Whether any features were found based on the criteria specified.
  returned: always
  sample: true
  type: bool
features:
  contains:
    additional_info:
      contains:
        install_name:
          description:
          - The action to perform once triggered, can be C(start_feature) or C(stop_feature).
          sample: ADCertificateServicesRole
          type: str
        major_version:
          description:
          - Major Version of feature C(name).
          sample: 8
          type: int
        minor_version:
          description:
          - Minor Version of feature C(name).
          sample: 0
          type: int
        number_id_version:
          description:
          - Numberic Id of feature C(name).
          sample: 16
          type: int
      description:
      - A list of privileges that the feature requires and will run with
      type: dict
    best_practices_model_id:
      description:
      - BestPracticesModelId for feature C(name).
      sample: Microsoft/Windows/UpdateServices
      type: str
    depends_on:
      description:
      - The command line that will be run when a C(run_command) failure action is
        fired.
      elements: str
      sample:
      - Web-Static-Content
      - Web-Default-Doc
      type: list
    depth:
      description:
      - Depth of C(name) feature.
      sample: 1
      type: int
    description:
      description:
      - The description of the feature.
      sample: Example description of the Windows feature.
      type: str
    display_name:
      description:
      - The Display name of feature found.
      sample: Active Directory Certificate Services
      type: str
    event_query:
      description:
      - The EventQuery for feature C(name).
      - This will be C(null) if None Present
      sample: IPAMServer.Events.xml
      type: str
    feature_type:
      description:
      - The Feature Type of C(name).
      - Values will be one of C(Role), C(Role Service), C(Feature).
      sample: Feature
      type: str
    install_state:
      description:
      - The Install State of C(name).
      - Values will be one of C(Available), C(Removed), C(Installed).
      sample: Installed
      type: str
    installed:
      description:
      - Whether the feature by C(name) is installed.
      sample: false
      type: bool
    name:
      description:
      - Name of feature found.
      sample: AD-Certificate
      type: str
    parent:
      description:
      - The parent of feature C(name) if present.
      sample: PowerShellRoot
      type: str
    path:
      description:
      - The Path of C(name) feature.
      sample: WoW64 Support
      type: str
    post_configuration_needed:
      description:
      - Tells if Post Configuration is needed for feature C(name).
      sample: false
      type: bool
    server_component_descriptor:
      description:
      - Descriptor of C(name) feature.
      sample: ServerComponent_AD_Certificate
      type: str
    sub_features:
      description:
      - List of sub features names of feature C(name).
      elements: str
      sample:
      - WAS-Process-Model
      - WAS-NET-Environment
      - WAS-Config-APIs
      type: list
    system_service:
      description:
      - The name of the service installed by feature C(name).
      elements: str
      sample:
      - iisadmin
      - w3svc
      type: list
  description:
  - A list of feature(s) that were found based on the criteria.
  - Will be an empty list if no features were found.
  elements: dict
  returned: always
  type: list

See also

• ansible.windows.win_feature