Skip to main content

groups

group_custom_targets(GROUP_NAME **kwargs)

This function can be used to create a custom group for targets.

Parameters

NameTypeDescription
GROUP_NAMEstringName of the group that needs to be created.

Keyword Arguments

NameTypeDescription
PATTERNstringif a pattern is given, the targets in the group list will be filtered and they must have the pattern to be included
LISTlist[string]if a list is given, the target in the group list are the one given in the list.

group_custom_ips(GROUP_NAME **kwargs)

This function can be used to create a custom group for IPs.

Parameters

NameTypeDescription
GROUP_NAMEstringName of the group that needs to be created.

Keyword Arguments

NameTypeDescription
PATTERNstringif a pattern is given, the IPs in the group list will be filtered and they must have the pattern to be included
LISTlist[string]if a list is given, the IPs in the group list are the one given in the list.

group_custom_options(GROUP_NAME **kwargs)

This function can be used to create a custom group for options.

Parameters

NameTypeDescription
GROUP_NAMEstringName of the group that needs to be created.

Keyword Arguments

NameTypeDescription
PATTERNstringif a pattern is given, the options in the group list will be filtered and they must have the pattern to be included
LISTlist[string]if a list is given, the options in the group list are the one given in the list.

get_all_targets_of_group(OUTVAR GROUP_NAME)

This function can be used to find all the target belonging to a given group. The output list will be stored in the OUTVAR argument.

Parameters

NameTypeDescription
OUTVARlist[string]List containing the targets found.
GROUP_NAMEstringName of the group to get the target from.