Dell PowerConnect W Clearpass 100 Software XMLRPC Interface TechNote - Page 15

Return Values

Page 15 highlights

amigopod XMLRPC Interface Version 0.9 Name username password password_value role_id enabled simultaneous_use do_schedule schedule_time do_expire expire_time expire_postlogin Return Values Name error message item uid *_error *_error_flag Type String String String Integer Flag Integer Flag String Integer String Integer Description Name of the guest account May be: random_password to indicate the account's password should be set to a random password password_value to indicate the account's password should be set to the value in the password_value field the empty string to leave the password unmodified Optional password to set the guest account's password (if the password field is password_value) RADIUS Role ID to assign to the guest account Boolean value indicating whether the account is enabled Number of simultaneous sessions allowed by the account Flag indicating if the account should be enabled at schedule_time Date and time at which the account will be enabled Action to take when the expire_time is reached Time at which the account will expire Time period for which the account will be valid after the first login, or 0 for indefinitely Type Flag String Struct Integer String Flag Description Set to 1 if the account was not modified Message describing the success or failure of the operation User structure containing updated field values ID of the guest account Field-specific error message Field-specific error flag, set to 1 if present CONFIDENTIAL 15

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21

amigopod XMLRPC Interface
Version 0.9
CONFIDENTIAL
15
Name
Type
Description
username
String
Name of the guest account
password
String
May be:
°
random_password
to indicate the
account’s password should be set to
a random password
°
password_value
to indicate the
account’s password should be set to
the value in the password_value field
°
the empty string to leave the
password unmodified
password_value
String
Optional password to set the guest
account’s password (if the
password
field is
password_value
)
role_id
Integer
RADIUS Role ID to assign to the guest
account
enabled
Flag
Boolean value indicating whether the
account is enabled
simultaneous_use
Integer
Number of simultaneous sessions
allowed by the account
do_schedule
Flag
Flag indicating if the account should be
enabled at schedule_time
schedule_time
String
Date and time at which the account will
be enabled
do_expire
Integer
Action to take when the expire_time is
reached
expire_time
String
Time at which the account will expire
expire_postlogin
Integer
Time period for which the account will be
valid after the first login, or 0 for
indefinitely
Return Values
Name
Type
Description
error
Flag
Set to 1 if the account was not modified
message
String
Message describing the success or
failure of the operation
item
Struct
User structure containing updated field
values
uid
Integer
ID of the guest account
*_error
String
Field-specific error message
*_error_flag
Flag
Field-specific error flag, set to 1 if present