ANTS Framework

com.github.ants-framework

ANTS Framework settings

macOS

Configuration Keys (3)

Key	Type	Title	Description	Default	Range
`PFC_SegmentedControl_0`required	string	—	—	—	—
`main`required	dict	General	General	—	—
`git_repository`	string	Git Repository	URL of the repository that contains your Ansible playbooks.	"https://github.com/ANTS-Framework/playbook.git"	—
`branch`	string	Branch	Git branch to check out from your Git repository.	"master"	—
`ssh_key`	string	SSH Key	Absolute path to a SSH key with permission to access your Git repository.	"/etc/ants/id_ants"	—
`destination`	string	Destination	Absolute path on the local machine to check out your Git repository.	"~root/.ants_playbook"	—
`inventory_script`	string	Inventory Script	Relative or absolute path to an ansible inventory script.	"inventory_default"	—
`wait_interval`	integer	Wait Interval	The number of seconds to wait in between ansible-pull runs.	900	—
`ansible_playbook`	string	Ansible Playbook	File name of the primary Ansible playbook to run relative to your <Destination> directory.	"main.yml"	—
`log_dir`	string	Log Directory	Absolute path of where to store log files from runs.	"/var/log/ants"	—
`ssh_stricthostkeychecking`	boolean	Strict Host Key Checking	Whether or not to use strict host key checking when running Git commands.	false	—
`ansible_pull_exe`	string	Ansible Pull	Absolute path to a different ansible-pull binary installed on the local machine.	""	—
`tags`	string	Tags	Limit the Ansible playbook run to a comma separated list of tags.	""	—
`skip_tags`	string	Skip Tags	Run the Ansible playbook on all tags except the provided comma separated list.	""	—
`ad`	dict	Active Directory	Active Directory	—	—
`ldap_user`	string	LDAP User	User name to use to connect to LDAP.	"ldap\changeme"	—
`ldap_pw`	string	LDAP Password	Password to use to connect to LDAP.	"changeme"	—
`ldap_host`	string	LDAP Host	LDAP server to connect to for inventory purposes.	"LDAP.PRETENDCORP.COM"	—
`ldap_ou_computers`	string	LDAP OU Computers	LDAP location of computer objects.	"DC=ldap,DC=pretendcorp,DC=com"	—
`ldap_ou_groups`	string	LDAP OU Groups	LDAP location of group objects.	"OU=ants,OU=Groups,DC=ldap,DC=pretendcorp,DC=com"	—
`cache_file`	string	Cache File	Absolute path to a cache file of Active Directory results.	"/etc/ants/inventory_cache.json"	—
`group_prefix`	string	Group Prefix	Group prefix used to filter groups from Active Directory.	"ants-"	—
`common_group`	string	Common Group	A common group to put all computers in.	"ants-common"	—
`common_ad_connected`	string	Common AD Connected	A common group that computers are put in when the inventory script actively connects to Active Directory.	"common_ad_connected"	—
`git_repository`	string	Git Repository	URL of the repository that contains your Ansible playbooks.	"https://github.com/ANTS-Framework/playbook.git"	—
`branch`	string	Branch	Git branch to check out from your Git repository.	"master"	—
`ssh_key`	string	SSH Key	Absolute path to a SSH key with permission to access your Git repository.	"/etc/ants/id_ants"	—
`destination`	string	Destination	Absolute path on the local machine to check out your Git repository.	"~root/.ants_playbook"	—
`inventory_script`	string	Inventory Script	Relative or absolute path to an ansible inventory script.	"inventory_default"	—
`wait_interval`	integer	Wait Interval	The number of seconds to wait in between ansible-pull runs.	900	—
`ansible_playbook`	string	Ansible Playbook	File name of the primary Ansible playbook to run relative to your <Destination> directory.	"main.yml"	—
`log_dir`	string	Log Directory	Absolute path of where to store log files from runs.	"/var/log/ants"	—
`ssh_stricthostkeychecking`	boolean	Strict Host Key Checking	Whether or not to use strict host key checking when running Git commands.	false	—
`ansible_pull_exe`	string	Ansible Pull	Absolute path to a different ansible-pull binary installed on the local machine.	""	—
`tags`	string	Tags	Limit the Ansible playbook run to a comma separated list of tags.	""	—
`skip_tags`	string	Skip Tags	Run the Ansible playbook on all tags except the provided comma separated list.	""	—
`ldap_user`	string	LDAP User	User name to use to connect to LDAP.	"ldap\changeme"	—
`ldap_pw`	string	LDAP Password	Password to use to connect to LDAP.	"changeme"	—
`ldap_host`	string	LDAP Host	LDAP server to connect to for inventory purposes.	"LDAP.PRETENDCORP.COM"	—
`ldap_ou_computers`	string	LDAP OU Computers	LDAP location of computer objects.	"DC=ldap,DC=pretendcorp,DC=com"	—
`ldap_ou_groups`	string	LDAP OU Groups	LDAP location of group objects.	"OU=ants,OU=Groups,DC=ldap,DC=pretendcorp,DC=com"	—
`cache_file`	string	Cache File	Absolute path to a cache file of Active Directory results.	"/etc/ants/inventory_cache.json"	—
`group_prefix`	string	Group Prefix	Group prefix used to filter groups from Active Directory.	"ants-"	—
`common_group`	string	Common Group	A common group to put all computers in.	"ants-common"	—
`common_ad_connected`	string	Common AD Connected	A common group that computers are put in when the inventory script actively connects to Active Directory.	"common_ad_connected"	—