Configuring the XML Server
This chapter describes how to configure the XML server and includes the following sections:
•
Configuring the Number of Allowed Sessions
•
Configuring the Session Timeout Period
•
Terminating a Server Session
•
Default Settings
•
Additional References
Configuring the Number of Allowed Sessions
Use this procedure to configure the maximum number of simultaneous sessions allowed on the XML server.
BEFORE YOU BEGIN
Before beginning this procedure, you must know or do the following:
•
You are logged in to the CLI in EXEC mode.
•
You can allow between 1 and 8 maximum sessions simultaneously on the XML server. The default is 8.
SUMMARY STEPS
1.
(Optional) show xml server status
2.
config t
3.
xml server max-session sessions
4.
(Optional) show xml server status
5.
(Optional) copy running-config startup-config
DETAILED STEPS
|
|
|
Step 1 |
show xml server status Example: switch# show xml server status operational status is enabled maximum session configured is 8 |
(Optional) Displays information about XML server settings and any active XML server sessions. |
Step 2 |
config t Example: switch# config t switch(config)# |
Places you in the CLI Global Configuration mode. |
Step 3 |
xml server max-session sessions Example: switch(config)# xml server max-session 6 |
Sets the number of allowed XML server sessions. The default is 8. The range is from 1 to 8. |
Step 4 |
show xml server status Example: switch(config)# show xml server status |
(Optional) Displays information about the XML server settings and active XML server sessions. |
Step 5 |
copy running-config startup-config Example: switch(config)# copy running-config startup-config [###############################] 100% n1000v(config)# |
(Optional) Saves the running configuration persistently through reboots and restarts by copying it to the startup configuration. |
Configuring the Session Timeout Period
Use this procedure to configure the inactive session timeout period on the XML server.
BEFORE YOU BEGIN
Before beginning this procedure, you must know or do the following:
•
You are logged in to the CLI in EXEC mode.
•
You can set the inactive session timeout period anywhere between 0 and 1200 seconds.
SUMMARY STEPS
1.
config t
2.
xml server timeout seconds
3.
(Optional) copy running-config startup-config
DETAILED STEPS
|
|
|
Step 1 |
config t Example: switch# config t switch(config)# |
Places you in the CLI Global Configuration mode. |
Step 2 |
xml server timeout seconds Example: switch(config)# xml server timeout 1200 switch(config)# |
Sets the number of seconds after which an inactive XML server session is terminated. The allowable range is from 0 to 1200 seconds. |
Step 3 |
copy running-config startup-config Example: switch(config)# copy running-config startup-config [###############################] 100% n1000v(config)# |
(Optional) Saves the running configuration persistently through reboots and restarts by copying it to the startup configuration. |
Terminating a Server Session
Use this procedure to terminate an active XML server session.
BEFORE YOU BEGIN
Before beginning this procedure, you must know or do the following:
•
You are logged in to the CLI in EXEC mode.
SUMMARY STEPS
1.
(Optional) show xml server status
2.
xml server terminate session
3.
(Optional) show xml server status
DETAILED STEPS
|
|
|
Step 1 |
show xml server status Example: switch(config)# show xml server status operational status is enabled maximum session configured is 8 switch(config)# |
(Optional) Displays information about the XML server settings and active XML server sessions. |
Step 2 |
xml server terminate session Example: switch(config)# xml server terminate 8665 switch(config)# |
Terminates the specified XML server session. |
Step 3 |
show xml server status Example: switch(config)# show xml server status |
(Optional) Displays information about the XML server settings and active XML server sessions. Verify that the session was terminated. |
Default Settings
Table 2-1 lists the default settings for the XML API.
Table 2-1 XML API Defaults
|
|
Maximum allowed XML server sessions |
8 |
Active XML server timeout period |
1200 seconds |
Additional References
For additional information related to implementing the XML management interface, see the following sections:
•
Standards
•
RFCs
Standards
|
|
No new or modified standards are supported by this feature, and support for existing standards has not been modified by this feature. |
— |
RFCs
|
|
RFC 4741 |
NETCONF Configuration Protocol |
RFC 4742 |
Using the NETCONF Configuration Protocol over Secure SHell (SSH) |