1ipa-test-config(1)           FreeIPA Manual Pages           ipa-test-config(1)
2
3
4

NAME

6       ipa-test-config  -  Generate FreeIPA test configuration for use in Bash
7       scripts
8

SYNOPSIS

10       ipa-test-config [options]
11       ipa-test-config [options] --global
12       ipa-test-config [options] hostname
13

DESCRIPTION

15       The FreeIPA integration test suite is configured by setting environment
16       variables.   The ipa-run-tests command reads these variables and prints
17       detailed configuration for shell-based scripts to standard output.  The
18       default  output of ipa-run-tests consists of export statements that can
19       be sourced by Bash.
20
21       If run without arguments, it prints out configuration specific  to  the
22       local  host.   Another host may be specified as an argument, or via the
23       --master, --replica, and --client options.  With the  --global  option,
24       it prints only configuration that is not specific to any host.
25
26

OPTIONS

28       -h, --help
29              Print out the command's usage and exit
30
31       --global
32              Output global configuration.
33
34       --domain
35              Output configuration for the given domain (environment).  May be
36              given as an index or name.  By default, domain 1 is used.
37
38       --master
39              Output configuration for the master
40
41       --replica
42              Output configuration for the replica with the given number
43
44       --replica
45              Output configuration for the client with the given number
46
47       --role Output configuration for the host with the given role.
48
49       --no-simple
50              Do not output Simple Vars.   These  are  normally  included  for
51              backwards compatibility.
52
53       --yaml Output  configuration  in  YAML  format  instead of Bash script.
54              This requires the PyYAML library to be installed.
55
56       --json Output configuration in JSON format instead of Bash script.
57
58

ENVIRONMENT VARIABLES

60       File-based configuration:
61
62
63       $IPATEST_YAML_CONFIG
64                  Specifies a file that contains configuration in YAML format,
65                  as given by ipa-test-config --global --yaml.
66                  If given, the other environment variables are ignored.
67                  This requires the PyYAML library to be installed.
68
69
70       $IPATEST_JSON_CONFIG
71                  Specifies a file that contains configuration in JSON format,
72                  as given by ipa-test-config --global --json.
73                  If given, the other environment variables are ignored.
74
75
76       Domain configuration:
77                  Domain is implicitly defined by _envX suffix of the environ‐
78              ment variables,
79                  if either AD_envX or MASTER_envX is defined.
80
81
82       Host configuration:
83
84
85       $MASTER
86                  FQDN of the first IPA server
87
88       $REPLICA
89                  FQDNs of other IPA servers (space-separated)
90
91       $CLIENT
92                  FQDNs of IPA clients (space-separated)
93
94       $MASTER_env2, $REPLICA_env2, $CLIENT_env2, $MASTER_env3, $AD_env4,...
95                  can be used for additional domains when needed
96
97       $AD_env1, $AD_env2, $AD_env3, $AD_env4, ...
98                  can  be used to define Active Directory domains. Please note
99              that these
100                  domains are not treated as separate from the IPA domains, so
101              please use an
102                  unique  environment suffix for each of your Active Directory
103              domains.
104
105       $TESTHOST_<keyword>_env<e>, e.g. $TESTHOST_LEGACY_env1
106                  Defines a host with  extra  role  identified  as  lowercased
107              <keyword>, e.g. 'legacy'.
108
109       $BEAKER<role><num>_IP_env<e>, e.g. $BEAKERREPLICA1_IP_env1
110                  the IP address of the given host
111                  Default: resolved via gethostbyname (or DNS if $IPv6SETUP is
112              set)
113
114
115       Basic configuration:
116
117
118       $IPATEST_DIR
119                  Directory for test data on the remote hosts
120                  Default: /root/ipatests
121
122       $DNSFORWARD
123                  IP of a DNS forwarder
124                  Default: 8.8.8.8
125
126       $IPA_ROOT_SSH_PASSWORD
127                  root password for the remote machines
128                  Used if $IPA_ROOT_SSH_KEY is not set.
129
130       $IPA_ROOT_SSH_KEY
131                  name of a file containing the private RSA key  for  root  on
132              the remote machines
133                  Default: ~/.ssh/id_rsa
134
135
136       Test customization:
137
138
139       $DOMAIN
140                  IPA domain name
141                  Default: taken from $MASTER
142
143       $NISDOMAIN
144                  NIS domain name
145                  Default: ipatest
146
147       $NTPSERVER
148                  NIS domain name
149                  Default: ipatest
150
151       $IPv6SETUP
152                  Set to TRUE for IPv6-only connectivity
153
154       $IPADEBUG
155                  Set to enable test debugging
156
157
158       $ADMINID
159                  Admin username
160                  Default: admin
161
162       $ADMINPW
163                  Admin user password
164                  Default: Secret123
165
166       $ADADMINID
167                  Active Directory Administrator username
168                  Default: Administrator
169
170       $ADADMINPW
171                  Active Directory Administrator password
172                  Default: Secret123
173
174       $ROOTDN
175                  Directory manager DN
176                  Default: cn=Directory Manager
177
178       $ROOTDNPWD
179                  Directory manager password
180                  Default: Secret123
181
182

EXIT STATUS

184       0 if the command was successful
185
186       1 if an error occurred
187
188

REFERENCES

190       A  full  description  of  the  FreeIPA integration testing framework is
191       available at http://www.freeipa.org/page/V3/Integration_testing
192
193
194
195FreeIPA                           Aug 29 2013               ipa-test-config(1)