Contents

# frozen_string_literal: true

require 'bolt/error'

# Adds a target to specified inventory group.
#
# **NOTE:** Not available in apply block
Puppet::Functions.create_function(:add_to_group) do
  # @param targets A pattern or array of patterns identifying a set of targets.
  # @param group The name of the group to add targets to.
  # @example Add new Target to group.
  #   Target.new('[e-mail]', 'password' => 'secret').add_to_group('group1')
  # @example Add new target to group by name.
  #   add_to_group('bolt:[e-mail]', 'group1')
  # @example Add an array of targets to group by name.
  #   add_to_group(['host1', 'group1', 'winrm://host2:54321'], 'group1')
  # @example Add a comma separated list list of targets to group by name.
  #   add_to_group('foo,bar,baz', 'group1')
  dispatch :add_to_group do
    param 'Boltlib::TargetSpec', :targets
    param 'String[1]', :group
  end

  def add_to_group(targets, group)
    unless Puppet[:tasks]
      raise Puppet::ParseErrorWithIssue
        .from_issue_and_stack(Bolt::PAL::Issues::PLAN_OPERATION_NOT_SUPPORTED_WHEN_COMPILING, action: 'add_to_group')
    end

    inventory = Puppet.lookup(:bolt_inventory)
    executor = Puppet.lookup(:bolt_executor)
    executor.report_function_call('add_to_group')

    inventory.add_to_group(inventory.get_targets(targets), group)
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
bolt-1.21.0	bolt-modules/boltlib/lib/puppet/functions/add_to_group.rb
bolt-1.20.0	bolt-modules/boltlib/lib/puppet/functions/add_to_group.rb