HP BL680c XenEnterprise Management API - Page 21

Class: session

Page 21 highlights

2.4. CLASS: SESSION CHAPTER 2. API REFERENCE 2.4 Class: session 2.4.1 Fields for class: session Name Description Quals RO run RO run RO run RO run RO run RW session A session. Field uuid this host this user last active pool other config Type string host ref user ref datetime bool (string → string) Map Description unique identifier/object reference Currently connected host Currently connected user Timestamp for last time session was active True if this session relates to a intrapool login, false otherwise additional configuration 2.4.2 RPCs associated with class: session RPC name: login with password Overview: Attempt to authenticate the user, returning a session reference if successful. Signature: (session ref) login_with_password (string uname, string pwd, string version) Arguments: type string string string name uname pwd version description Username for login. Password for login. Client API version. Return Type: session ref reference of newly created session Possible Error Codes: SESSION AUTHENTICATION FAILED RPC name: logout Overview: Log out of a session. Signature: void logout (session_id s) Return Type: void RPC name: change password Overview: Change the account password; if your session is authenticated with root priviledges then the old pwd is validated and the new pwd is set regardless. Signature: 21

  • 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
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
  • 235
  • 236
  • 237
  • 238
  • 239
  • 240
  • 241
  • 242
  • 243
  • 244
  • 245
  • 246
  • 247
  • 248
  • 249
  • 250
  • 251
  • 252
  • 253
  • 254
  • 255
  • 256
  • 257
  • 258
  • 259
  • 260
  • 261
  • 262
  • 263
  • 264
  • 265
  • 266
  • 267
  • 268
  • 269
  • 270
  • 271
  • 272
  • 273
  • 274
  • 275
  • 276
  • 277
  • 278
  • 279
  • 280
  • 281
  • 282
  • 283
  • 284
  • 285
  • 286
  • 287
  • 288
  • 289
  • 290
  • 291
  • 292
  • 293
  • 294
  • 295
  • 296
  • 297
  • 298
  • 299
  • 300
  • 301
  • 302
  • 303
  • 304
  • 305
  • 306
  • 307
  • 308
  • 309
  • 310
  • 311
  • 312
  • 313

2.4. CLASS: SESSION
CHAPTER 2. API REFERENCE
2.4
Class: session
2.4.1
Fields for class: session
Name
session
Description
A session.
Quals
Field
Type
Description
RO
run
uuid
string
unique identifier/object reference
RO
run
this
host
host ref
Currently connected host
RO
run
this
user
user ref
Currently connected user
RO
run
last
active
datetime
Timestamp for last time session was
active
RO
run
pool
bool
True if this session relates to a intra-
pool login, false otherwise
RW
other
config
(string
string) Map
additional configuration
2.4.2
RPCs associated with class: session
RPC name: login
with
password
Overview:
Attempt to authenticate the user, returning a session reference if successful.
Signature:
(session ref) login_with_password (string uname, string pwd, string version)
Arguments:
type
name
description
string
uname
Username for login.
string
pwd
Password for login.
string
version
Client API version.
Return Type:
session ref
reference of newly created session
Possible Error Codes:
SESSION
AUTHENTICATION
FAILED
RPC name: logout
Overview:
Log out of a session.
Signature:
void logout (session_id s)
Return Type:
void
RPC name: change
password
Overview:
Change the account password; if your session is authenticated with root priviledges then the
old
pwd is validated and the new
pwd is set regardless.
Signature:
21