Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation  Back up to About Overview 
  
[+] Expand All
[-] Collapse All

Client Response Elements

This section provides a detailed description of each element in the client response. A description is provided for each element, along with both the XML and schema representation.

Element: attribute

This element represents a RADIUS attribute or VSA that is returned from a query or other operation.

XML Instance Representation

<attribute
name="string [1]"
sequence="integer [1]"
value="string [1]"/>

Schema Component Representation

<element name="attribute">
<complexType>
<attribute name="name" type=" string " use="required"/>
<attribute name="sequence" type=" integer " use="required"/>
<attribute name="value" type=" string " use="required"/>
</complexType>
</element>

Element: attributes

This element is simply a grouping node to collect a set of <attribute> nodes in the returned structure.

Note: Subattributes are not supported in CoA/DM actions.

XML Instance Representation

<attributes>
<attribute> ... </attribute> [1..*]
</attributes>

Schema Component Representation

<element name="attributes">
<complexType>
<sequence>
<element ref=" attribute " maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>

Element: body

This element has no semantic function and is placed in the output to mirror the structure of a SOAP response.

XML Instance Representation

<body>
<clientResults> ... </clientResults> [1]
</body>

Schema Component Representation

<element name="body">
<complexType>
<sequence>
<element ref=" clientResults "/>
</sequence>
</complexType>
</element>

Element: clientRequest

This element contains the query and action attributes sent by the client in the previous client request. It is presented in the client response for reference only.

XML Instance Representation

<clientRequest
action="string [1]"> <attributes> ... </attributes> [0..1] </clientRequest>

Schema Component Representation

<element name="clientRequest">
<complexType>
<sequence>
<element ref=" attributes " minOccurs="0"/>
</sequence>
<attribute name="action" type=" string " use="required"/>
</complexType>
</element>

Element: clientResponse

This top-level element contains the entire response to the client request. It aggregates multiple per-session responses for all affected sessions.

XML Instance Representation

<clientResponse
resultCode="integer [1]"
resultMessage="string [1]">
<sessionResults> ... </sessionResults> [0..*]
</clientResponse>

Schema Component Representation

<element name="clientResponse">
<complexType>
<sequence>
<element ref=" sessionResults " minOccurs="0" maxOccurs="unbounded"/>
</sequence>
<attribute name="resultCode" type=" integer " use="required"/>
<attribute name="resultMessage" type=" string " use="required"/>
</complexType>
</element>

Element: clientResult

This element is merely a grouping of a clientRequest and related clientResponse and has no semantic meaning.

XML Instance Representation

<clientResult
sequence="integer [1]"> <clientRequest> ... </clientRequest> [1] <clientResponse> ... </clientResponse> [1] </clientResult>

Schema Component Representation

<element name="clientResult">
<complexType>
<sequence>
<element ref=" clientRequest "/>
<element ref=" clientResponse "/>
</sequence>
<attribute name="sequence" type=" integer " use="required"/>
</complexType>
</element>

Element: clientResults

This element groups multiple clientResult elements. This release of Steel-Belted Radius Carrier supports only a single clientResult object per response, so this element is for future expansion.

XML Instance Representation

<clientResults>
<clientResult> ... </clientResult> [1..*]
</clientResults>

Schema Component Representation

<element name="clientResults">
<complexType>
<sequence>
<element ref=" clientResult " maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>

Element: defaultAttribute

This element appears in a deviceRequestSpec element, and specifies that this attribute may be provided in the clientRequest; otherwise it is defaulted to the specified value.

Note: Subattributes are not supported in CoA/DM actions.

XML Instance Representation

<defaultAttribute
name="string [1]"
sequence="integer [1]"
value="string [1]"/>

Schema Component Representation

<element name="defaultAttribute">
<complexType>
<attribute name="name" type=" string " use="required"/>
<attribute name="sequence" type=" integer " use="required"/>
<attribute name="value" type=" string " use="required"/>
</complexType>
</element>

Element: deviceRequest

This element contains the exact request sent to a device, if any. By searching this element, the client management application can determine the actual attributes sent to the device, and whether they were populated from the client request or from the session database (CST).

XML Instance Representation

<deviceRequest
address="string [1]"
code="string [1]"
port="integer [1]"
type="string [1]"> <attributes> ... </attributes> [1] </deviceRequest>

Schema Component Representation

<element name="deviceRequest">
<complexType>
<sequence>
<element ref=" attributes "/>
</sequence>
<attribute name="address" type=" string " use="required"/>
<attribute name="code" type=" string " use="required"/>
<attribute name="port" type=" integer " use="required"/>
<attribute name="type" type=" string " use="required"/>
</complexType>
</element>

Element: deviceRequestSpec

This element is only present when a request fails because it required attributes that were present in neither the clientRequest or the session table (CST).

XML Instance Representation

<deviceRequestSpec>
<requiredAttribute> ... </requiredAttribute> [1..*]
<optionalAttribute> ... </optionalAttribute> [1..*]
<defaultAttribute> ... </defaultAttribute> [1..*]
<overrideAttribute> ... </overrideAttribute> [1..*]
</deviceRequestSpec>

Schema Component Representation

<element name="deviceRequestSpec">
<complexType>
<sequence>
<element ref=" requiredAttribute " maxOccurs="unbounded"/>
<element ref=" optionalAttribute " maxOccurs="unbounded"/>
<element ref=" defaultAttribute " maxOccurs="unbounded"/>
<element ref=" overrideAttribute " maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>

Element: deviceResponse

This element contains the attributes received in a response from the device, if any. Usually, there are not any attributes, except in the case of a NAK with an error result. The attribute resultCode carries a numeric code that is meaningful to Juniper Networks Technical Support, and the resultMessage carries a human-readable result message. Table 113 lists all result codes with the corresponding result messages for the deviceResponse element.

Table 113: Result Codes and Result Messages for deviceResponse

Result Codes

Result Messages

3000000

unknown session control result code

3010000

session control request complete

3010100

session control request successful

3010200

session control request failed

3010201

session control request rejected by device

3010202

number of session affected by the session control request exceeds the limit

3020303

need more information to format session control request

3020000

session control request did not complete

3020100

malformed session control request

3020101

session control request from unauthorized source

3020102

session control request discarded by plug-in

3020103

unknown action specified or invalid license for session control request

3020104

unknown attribute specified in session control request

3020200

server ran out of resources while processing session control request

3020201

server is too busy to process session control request

3020202

session control request timed out

3020300

session control request cannot be processed on this server

3020301

no matching session for session control request

3020302

no matching controlled device for session control request

3020600

session control request is retry of request currently in progress

XML Instance Representation

<deviceResponse
resultCode="integer [1]"
resultMessage="string [1]"> <attributes> ... </attributes> [1] </deviceResponse>

Schema Component Representation

<element name="deviceResponse">
<complexType>
<sequence>
<element ref=" attributes "/>
</sequence>
<attribute name="resultCode" type=" integer " use="required"/>
<attribute name="resultMessage" type=" string " use="required"/>
</complexType>
</element>

Element: deviceResult

This element represents a CoA or DM operation that was executed or attempted to execute against a particular device. It contains either a pair of deviceRequest and associated deviceResponse, or only a deviceRequestSpec in cases where the request could not be sent because the required attributes were not available.

XML Instance Representation

<deviceResult
device="string [1]"
sequence="integer [1]">
Start Choice [0..1] <deviceRequestSpec> ... </deviceRequestSpec> [1] <deviceRequest> ... </deviceRequest> [1] <deviceResponse> ... </deviceResponse> [1] End Choice
</deviceResult>

Schema Component Representation

<element name="deviceResult">
<complexType>
<choice minOccurs="0">
<element ref=" deviceRequestSpec "/>
<sequence>
<element ref=" deviceRequest "/>
<element ref=" deviceResponse "/>
</sequence>
</choice>
<attribute name="device" type=" string " use="required"/>
<attribute name="sequence" type=" integer " use="required"/>
</complexType>
</element>

Element: deviceResults

This element groups multiple deviceResult elements, indicating the actual CoA or DM requests that were sent to devices in order to execute the requested action for a particular session.

This release of Steel-Belted Radius Carrier supports only a single deviceRequest for each session. However, we recommend you design your client management application to handle multiple deviceRequest nodes to take advantage of this element in future Steel-Belted Radius Carrier releases.

XML Instance Representation

<deviceResults>
<deviceResult> ... </deviceResult> [1..*]
</deviceResults>

Schema Component Representation

<element name="deviceResults">
<complexType>
<sequence>
<element ref=" deviceResult " maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>

Element: envelope

This element has no semantic meaning and is placed here only to mirror the structure of a SOAP response.

XML Instance Representation

<envelope>
<header> ... </header> [1]
<body> ... </body> [1]
</envelope>

Schema Component Representation

<element name="envelope">
<complexType>
<sequence>
<element ref=" header "/>
<element ref=" body "/>
</sequence>
</complexType>
</element>

Element: header

This element has no semantic meaning and is placed here only to mirror the structure of a SOAP response.

XML Instance Representation

<header/> 

Schema Component Representation

<element name="header">
<complexType/>
</element>

Element: optionalAttribute

This element appears in a deviceRequestSpec and specifies that this attribute may optionally be provided in the clientRequest. For information regarding this element, see Configuring the deviceModels.xml File.

XML Instance Representation

<optionalAttribute
name="string [1]"
sequence="integer [1]"/>

Schema Component Representation

<element name="optionalAttribute">
<complexType>
<attribute name="name" type=" string " use="required"/>
<attribute name="sequence" type=" integer " use="required"/>
</complexType>
</element>

Element: overrideAttribute

This element appears in a deviceRequestSpec and specifies that this attribute is always used with the specified value, even if it was present in the clientRequest. For information regarding this element, see Configuring the deviceModels.xml File.

XML Instance Representation

<overrideAttribute
name="string [1]"
sequence="integer [1]"
value="string [1]"/>

Schema Component Representation

<element name="overrideAttribute">
<complexType>
<attribute name="name" type=" string " use="required"/>
<attribute name="sequence" type=" integer " use="required"/>
<attribute name="value" type=" string " use="required"/>
</complexType>
</element>

Element: requiredAttribute

This element appears in a deviceRequestSpec and specifies that this attribute must be provided in the clientRequest; otherwise the request cannot be executed. For information regarding this element, see Configuring the deviceModels.xml File.

XML Instance Representation

<requiredAttribute
name="string [1]"
sequence="integer [1]"/>

Schema Component Representation

<element name="requiredAttribute">
<complexType>
<attribute name="name" type=" string " use="required"/>
<attribute name="sequence" type=" integer " use="required"/>
</complexType>
</element>

Element: sessionData

This element contains the attributes found in the session table (CST). For each session matched by the clientRequest, a sessionData element is present.

XML Instance Representation

<sessionData>
<attributes> ... </attributes> [1]
</sessionData>

Schema Component Representation

<element name="sessionData">
<complexType>
<sequence>
<element ref=" attributes "/>
</sequence>
</complexType>
</element>

Element: sessionRequest

This element contains the clientRequest customized for a particular session, by filling in any missing information from the sessionData element. There is one sessionRequest for each session matched by the clientRequest.

XML Instance Representation

<sessionRequest>
<attributes> ... </attributes> [0..1]
</sessionRequest>

Schema Component Representation

<element name="sessionRequest">
<complexType>
<sequence>
<element ref=" attributes " minOccurs="0"/>
</sequence>
</complexType>
</element>

Element: sessionResponse

This element contains the response to the sessionRequest for a particular session. There is one sessionRequest for each session matched by the clientRequest.

XML Instance Representation

<sessionResponse
resultCode="integer [1]"
resultMessage="string [1]"> <attributes> ... </attributes> [0..1] </sessionResponse>

Schema Component Representation

<element name="sessionResponse">
<complexType>
<sequence>
<element ref=" attributes " minOccurs="0"/>
</sequence>
<attribute name="resultCode" type=" integer " use="required"/>
<attribute name="resultMessage" type=" string " use="required"/>
</complexType>
</element>

Element: sessionResult

This element groups all the activity for a particular session matched by the clientRequest.

XML Instance Representation

<sessionResult
sequence="integer [1]"> <sessionData> ... </sessionData> [0..1] <sessionRequest> ... </sessionRequest> [1] <deviceResults> ... </deviceResults> [0..1] <sessionResponse> ... </sessionResponse> [1] </sessionResult>

Schema Component Representation

<element name="sessionResult">
<complexType>
<sequence>
<element ref=" sessionData " minOccurs="0"/>
<element ref=" sessionRequest "/>
<element ref=" deviceResults " minOccurs="0"/>
<element ref=" sessionResponse "/>
</sequence>
<attribute name="sequence" type=" integer " use="required"/>
</complexType>
</element>

Element: sessionResults

This element groups all the sessionResult nodes for the sessions matched by the clientRequest.

XML Instance Representation

<sessionResults
type="string [1]"> <sessionResult> ... </sessionResult> [1..*] </sessionResults>

Schema Component Representation

<element name="sessionResults">
<complexType>
<sequence>
<element ref=" sessionResult " maxOccurs="unbounded"/>
</sequence>
<attribute name="type" type=" string " use="required"/>
</complexType>
</element>

Modified: 2017-09-27