summaryrefslogtreecommitdiffstats
path: root/doc/sphinx/Pacemaker_Administration/options.rst
blob: 731d17f288b1c83e00c7d0f533e7997050b7f039 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
.. index:: client options

Client Options
--------------

Pacemaker uses several environment variables set on the client side.

.. note:: Directory and file paths below may differ on your system depending on
          your Pacemaker build settings. Check your Pacemaker configuration
          file to find the correct paths.

.. list-table:: **Client-side Environment Variables**
   :class: longtable
   :widths: 2 4 5
   :header-rows: 1

   * - Environment Variable
     - Default
     - Description
   * - .. _CIB_encrypted:

       .. index::
          single: CIB_encrypted
          single: environment variable; CIB_encrypted

       CIB_encrypted
     - true
     - Whether to encrypt network traffic. Used with :ref:`CIB_port <CIB_port>`
       for connecting to a remote CIB instance; ignored if
       :ref:`CIB_port <CIB_port>` is not set.
   * - .. _CIB_file:

       .. index::
          single: CIB_file
          single: environment variable; CIB_file

       CIB_file
     -
     - If set, CIB connections are created against the named XML file. Clients
       read an input CIB from, and write the result CIB to, the named file.
       Ignored if :ref:`CIB_shadow <CIB_shadow>` is set.
   * - .. _CIB_passwd:

       .. index::
          single: CIB_passwd
          single: environment variable; CIB_passwd

       CIB_passwd
     -
     - :ref:`$CIB_user <CIB_user>`'s password. Read from the command line if
       unset. Used with :ref:`CIB_port <CIB_port>` for connecting to a remote
       CIB instance; ignored if :ref:`CIB_port <CIB_port>` is not set.
   * - .. _CIB_port:

       .. index::
          single: CIB_port
          single: environment variable; CIB_port

       CIB_port
     -
     - If set, CIB connections are created as clients to a remote CIB instance
       on :ref:`$CIB_server <CIB_server>` via this port. Ignored if
       :ref:`CIB_shadow <CIB_shadow>` or :ref:`CIB_file <CIB_file>` is set.
   * - .. _CIB_server:

       .. index::
          single: CIB_server
          single: environment variable; CIB_server

       CIB_server
     - localhost
     - The host to connect to. Used with :ref:`CIB_port <CIB_port>` for
       connecting to a remote CIB instance; ignored if
       :ref:`CIB_port <CIB_port>` is not set.
   * - .. _CIB_shadow:

       .. index::
          single: CIB_shadow
          single: environment variable; CIB_shadow

       CIB_shadow
     -
     - If set, CIB connections are created against a temporary working
       ("shadow") CIB file called ``shadow.$CIB_shadow`` in
       :ref:`$CIB_shadow_dir <CIB_shadow_dir>`. Should be set only to the name
       of a shadow CIB created by :ref:`crm_shadow <crm_shadow>`. Otherwise,
       behavior is undefined.
   * - .. _CIB_shadow_dir:

       .. index::
          single: CIB_shadow_dir
          single: environment variable; CIB_shadow_dir

       CIB_shadow_dir
     - |CRM_CONFIG_DIR| if the current user is ``root`` or |CRM_DAEMON_USER|;
       otherwise ``$HOME/.cib`` if :ref:`$HOME <HOME>` is set; otherwise
       ``$TMPDIR/.cib`` if :ref:`$TMPDIR <TMPDIR>` is set to an absolute path;
       otherwise ``/tmp/.cib``
     - If set, shadow files are created in this directory. Ignored if
       :ref:`CIB_shadow <CIB_shadow>` is not set.
   * - .. _CIB_user:

       .. index::
          single: CIB_user
          single: environment variable; CIB_user

       CIB_user
     - |CRM_DAEMON_USER| if used with :ref:`CIB_port <CIB_port>`, or the current
       effective user otherwise
     - If used with :ref:`CIB_port <CIB_port>`, connect to
       :ref:`$CIB_server <CIB_server>` as this user. Must be part of the
       |CRM_DAEMON_GROUP| group on :ref:`$CIB_server <CIB_server>`. Otherwise
       (without :ref:`CIB_port <CIB_port>`), this is used only for ACL and
       display purposes.
   * - .. _EDITOR:

       .. index::
          single: EDITOR
          single: environment variable; EDITOR

       EDITOR
     -
     - Text editor to use for editing shadow files. Required for the ``--edit``
       command of :ref:`crm_shadow <crm_shadow>`.
   * - .. _HOME:

       .. index::
          single: HOME
          single: environment variable; HOME

       HOME
     - Current user's home directory as configured in the passwd database, if an
       entry exists
     - Used to create a default :ref:`CIB_shadow_dir <CIB_shadow_dir>` for non-
       privileged users.
   * - .. _PE_fail:

       .. index::
          single: PE_fail
          single: environment variable; PE_fail

       PE_fail
     - 0
     - Advanced use only: A dummy graph action with action ID matching this
       option will be marked as failed. Primarily for developer use with
       scheduler simulations.
   * - .. _PS1:

       .. index::
          single: PS1
          single: environment variable; PS1

       PS1
     -
     - The shell's primary prompt string. Used by
       :ref:`crm_shadow <crm_shadow>`: set to indicate that the user is in an
       interactive shadow CIB session, and checked to determine whether the user
       is already in an interactive session before creating a new one.
   * - .. _SHELL:

       .. index::
          single: SHELL
          single: environment variable; SHELL

       SHELL
     -
     - Absolute path to a shell. Used by :ref:`crm_shadow <crm_shadow>` when
       launching an interactive session.
   * - .. _TMPDIR:

       .. index::
          single: TMPDIR
          single: environment variable; TMPDIR

       TMPDIR
     - /tmp
     - Directory for temporary files. If not an absolute path, the default is
       used instead.