summaryrefslogtreecommitdiffstats
path: root/schemas/clients.xsd
blob: b6d04b3bf470313b379d8355d3c65b88cd9ce4d8 (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
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xml:lang="en">
  <xsd:annotation>
    <xsd:documentation>
      Bcfg2 client list schema
    </xsd:documentation>
  </xsd:annotation>

  <xsd:import namespace="http://www.w3.org/XML/1998/namespace"
              schemaLocation="xml.xsd"/>

  <xsd:simpleType name="MetadataAuthEnum">
    <xsd:restriction base="xsd:token">
      <xsd:enumeration value="cert+password"/>
      <xsd:enumeration value="bootstrap"/>
      <xsd:enumeration value="cert"/>
    </xsd:restriction>
  </xsd:simpleType>

  <xsd:complexType name='ClientType'>
    <xsd:annotation>
      <xsd:documentation>
        Describe a Bcfg2 client machine.
      </xsd:documentation>
    </xsd:annotation>
    <xsd:choice minOccurs='0' maxOccurs='unbounded'>
      <xsd:element name='Alias'>
        <xsd:annotation>
          <xsd:documentation>
            **Alias** allows you to set alternative hostname and IP
            address pairs that also resolve to this client.
          </xsd:documentation>
        </xsd:annotation>
        <xsd:complexType>
          <xsd:attribute type='xsd:string' name='name' use='required'>
            <xsd:annotation>
              <xsd:documentation>
                Hostname of the alternative client name-address pair.
              </xsd:documentation>
            </xsd:annotation>
          </xsd:attribute>
          <xsd:attribute type='xsd:string' name='address'>
            <xsd:annotation>
              <xsd:documentation>
                IP address of the alternative client name-address pair.
              </xsd:documentation>
            </xsd:annotation>
          </xsd:attribute>
        </xsd:complexType>
      </xsd:element>
    </xsd:choice>
    <xsd:attribute type='xsd:string' name='name' use='required'>
      <xsd:annotation>
        <xsd:documentation>
          Hostname of client.  This needs to be the name (probably
          FQDN) returned by a reverse lookup on the connecting IP
          address.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type='xsd:string' name='profile' use='required'>
      <xsd:annotation>
        <xsd:documentation>
          Profile group name to associate this client with.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type='xsd:string' name='pingable'>
      <xsd:annotation>
        <xsd:documentation>
          Deprecated.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type='MetadataAuthEnum' name='auth' default="cert+password">
      <xsd:annotation>
        <xsd:documentation>
          Authentication mode for the client.  See
          :ref:`appendix-guides-authentication` for details on the
          values available.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type='xsd:string' name='uuid'>
      <xsd:annotation>
        <xsd:documentation>
          Establishes a name for this cilent that can be used to
          bypass dns-based client resolution.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type='xsd:string' name='password'>
      <xsd:annotation>
        <xsd:documentation>
          Establishes a per-client password that can be used instead
          of the global password.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type='xsd:string' name='location'>
      <xsd:annotation>
        <xsd:documentation>
          Deprecated.  Use :xml:attribute:`ClientType:floating` instead.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type='xsd:boolean' name='floating' default="false">
      <xsd:annotation>
        <xsd:documentation>
          Allows requests to come from any IP address, rather than
          requiring requests to come from an IP associated with this
          client.  Note that, since this forces the Bcfg2 server to
          trust any connection that claims to be from this hostname,
          it can introduce security issues.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type='xsd:boolean' name='secure' default="false">
      <xsd:annotation>
        <xsd:documentation>
          Requires the use of :xml:attribute:`ClientType:password` for
          this client.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type='xsd:string' name='pingtime'>
      <xsd:annotation>
        <xsd:documentation>
          Deprecated.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type='xsd:string' name='address'>
      <xsd:annotation>
        <xsd:documentation>
          Establishes an extra IP address that resolves to this client.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type='xsd:token' name='version'>
      <xsd:annotation>
        <xsd:documentation>
          The version of the Bcfg2 client running on this machine.
          You should not have to set this manually, but can let the
          Bcfg2 server set it automatically.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
  </xsd:complexType>

  <xsd:complexType name='ClientsType'>
    <xsd:annotation>
      <xsd:documentation>
        Metadata client list top-level tag
      </xsd:documentation>
    </xsd:annotation>
    <xsd:choice minOccurs='0' maxOccurs='unbounded'>
      <xsd:element name='Client' type='ClientType'/>
      <xsd:element name='Clients' type='ClientsType'/>
    </xsd:choice>
    <xsd:attribute name='version' type='xsd:string'>
      <xsd:annotation>
        <xsd:documentation>
          Client schema version
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute ref="xml:base"/>
  </xsd:complexType>

  <xsd:element name='Clients' type='ClientsType'/>
</xsd:schema>