PayloadKit

ANTS Framework

com.github.ants-framework

ANTS Framework settings

macOS

Configuration Keys (3)

KeyTypeDescriptionDefaultRange
string—Default: —Range: —
maindict

General

required
dictGeneralDefault: —Range: —

Git Repository

stringURL of the repository that contains your Ansible playbooks.Default: "https://github.com/ANTS-Framework/playbook.git"Range: —
branchstring

Branch

stringGit branch to check out from your Git repository.Default: "master"Range: —
ssh_keystring

SSH Key

stringAbsolute path to a SSH key with permission to access your Git repository.Default: "/etc/ants/id_ants"Range: —

Destination

stringAbsolute path on the local machine to check out your Git repository.Default: "~root/.ants_playbook"Range: —

Inventory Script

stringRelative or absolute path to an ansible inventory script.Default: "inventory_default"Range: —

Wait Interval

integerThe number of seconds to wait in between ansible-pull runs.Default: 900Range: —

Ansible Playbook

stringFile name of the primary Ansible playbook to run relative to your <Destination> directory.Default: "main.yml"Range: —
log_dirstring

Log Directory

stringAbsolute path of where to store log files from runs.Default: "/var/log/ants"Range: —

Strict Host Key Checking

booleanWhether or not to use strict host key checking when running Git commands.Default: falseRange: —

Ansible Pull

stringAbsolute path to a different ansible-pull binary installed on the local machine.Default: ""Range: —
tagsstring

Tags

stringLimit the Ansible playbook run to a comma separated list of tags.Default: ""Range: —
skip_tagsstring

Skip Tags

stringRun the Ansible playbook on all tags except the provided comma separated list.Default: ""Range: —
ldap_userstring

LDAP User

stringUser name to use to connect to LDAP.Default: "ldap\changeme"Range: —
ldap_pwstring

LDAP Password

stringPassword to use to connect to LDAP.Default: "changeme"Range: —
ldap_hoststring

LDAP Host

stringLDAP server to connect to for inventory purposes.Default: "LDAP.PRETENDCORP.COM"Range: —

LDAP OU Computers

stringLDAP location of computer objects.Default: "DC=ldap,DC=pretendcorp,DC=com"Range: —

LDAP OU Groups

stringLDAP location of group objects.Default: "OU=ants,OU=Groups,DC=ldap,DC=pretendcorp,DC=com"Range: —

Cache File

stringAbsolute path to a cache file of Active Directory results.Default: "/etc/ants/inventory_cache.json"Range: —

Group Prefix

stringGroup prefix used to filter groups from Active Directory.Default: "ants-"Range: —

Common Group

stringA common group to put all computers in.Default: "ants-common"Range: —

Common AD Connected

stringA common group that computers are put in when the inventory script actively connects to Active Directory.Default: "common_ad_connected"Range: —