-
Cisco IOS Network Management Command Reference
-
Introduction
-
absolute through action snmp-trap
-
action string compare through buffers tune automatic
-
calendar set through clock update-calendar
-
cns aaa authentication through discover (cns)
-
emm through event manager scheduler script
-
event manager scheduler suspend through hw-module logging onboard (Cat 6K)
-
idle-timeout (WSMA) through ip director server weights
-
ip dns server through kron policy-list
-
line-cli through logging userinfo
-
major rising through ntp update-calendar
-
object id (action notification) through rmon queuesize
-
sample (expression) through show ethernet oam status
-
show event manager detector through show event manager session cli username
-
show facility-alarm through show ntp status
-
show odm-format through show rmon topn
-
show snmp through snmp mib event sample
-
snmp mib event trigger owner through snmp-server enable informs
-
snmp-server enable traps through snmp-server enable traps ospf cisco-specific retransmit
-
snmp-server enable traps ospf cisco-specific state-change through snmp-server enable traps voice poor-qov
-
snmp-server engineID local through snmp trap link-status
-
sntp broadcast client through xsm vdm
-
Feedback
Table Of Contents
ip drp authentication key-chain
ip http active-session-modules
ip http client secure-ciphersuite
ip http client secure-trustpoint
ip http client source-interface
ip http secure-active-session-modules
ip dns server
To enable the Domain Name System (DNS) server on a router, use the ip dns server command in global configuration mode. To disable the DNS server, use the no form of the command.
ip dns server
no ip dns server
Syntax Description
This command has no arguments or keywords.
Command Default
The DNS server is disabled.
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command to enable the DNS server as needed.
Examples
In the following example, the DNS server is enabled:
Router(config)# ip dns serverip drp access-group
To control the sources of Director Response Protocol (DRP) queries to the DRP server agent, use the ip drp access-group command in global configuration mode. To remove the access list, use the no form of this command.
ip drp access-group access-list-number
no ip drp access-group access-list-number
Syntax Description
access-list-number
Number of a standard IP access list in the range from 1 to 99 or from 1300 to 1999.
Defaults
The DRP server agent will answer all queries.
Command Modes
Global configuration
Command History
Usage Guidelines
This command applies an access list to the interface, thereby controlling which devices can send queries to the DRP Server Agent.
If both an authentication key chain and an access group have been specified, both security measures must permit access before a request is processed.
Examples
The following example configures access list 1, which permits only queries from the host at 10.45.12.4:
Router(config)# access-list 1 permit 10.45.12.4Router(config)# ip drp access-group 1Related Commands
ip drp authentication key-chain
To configure authentication on the Director Response Protocol (DRP) Server Agent for DistributedDirector, use the ip drp authentication key-chain command in global configuration mode. To remove the key chain, use the no form of this command.
ip drp authentication key-chain name-of-chain
no ip drp authentication key-chain name-of-chain
Syntax Description
Defaults
No authentication is configured for the DRP Server Agent.
Command Modes
Global configuration
Command History
Usage Guidelines
When a key chain and key are configured, the key is used to authenticate all DRP requests and responses. The active key on the DRP Server Agent must match the active key on the primary agent. Use the key and key-string commands to configure the key.
Examples
The following example configures a key chain named ddchain:
Router(config)# ip drp authentication key-chain ddchainRelated Commands
ip drp domain
To add a new domain to the DistributedDirector client or to configure an existing domain, use the ip drp domain command in global configuration mode. To remove this command from the configuration file and restore the system to its default condition with respect to this command, use the no form of this command.
ip drp domain domain-name
no ip drp domain domain-name
Syntax Description
Command Default
No default domain is configured.
Command Modes
Global configuration
Command History
Usage Guidelines
The ip drp domain command can be used only on a Director Response Protocol (DRP) agent. The boomerang client is the DRP agent.
Enabling this command puts the client in boomerang configuration mode.
Use the ip drp domain command to enter a new or existing domain name. Entering a new domain name creates a new domain, and entering an existing domain name allows the user to configure the specified domain. When a domain name is configured on the boomerang client, the user can configure specific parameters, such as server address, aliases, and time to live (TTL) values, for that domain.
When a Director Response Protocol (DRP) agent receives a Domain Name System (DNS) racing message from boomerang servers such as DistributedDirector, the DRP agent extracts the specified domain name (for example, www.cisco.com) in the DNS message.
Examples
In the following example, a domain named "www.boom1.com" is added on the boomerang client:
Router(config)# ip drp domain www.boom1.comRouter# show running-config...ip drp domain www.boom1.comRelated Commands
ip drp server
To enable the Director Response Protocol (DRP) Server Agent that works with DistributedDirector, use the ip drp server command in global configuration mode. To disable the DRP Server Agent, use the no form of this command.
ip drp server
no ip drp server
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Examples
The following example enables the DRP Server Agent:
Router(config)# ip drp serverRelated Commands
ip host ns
To create a name server (NS) resource record to be returned when a Domain Name System (DNS) server is queried for the associated domain, use the ip host ns command in global configuration mode. To remove the NS records, use the no form of this command.
ip host domain-name ns server-name
no ip host domain-name ns server-name
Syntax Description
domain-name
Name of the authority that is delegated to another NS, such as a second-level DistributedDirector.
server-name
Name of the second-level DNS server.
Command Default
None.
Command Modes
Global configuration
Command History
Usage Guidelines
The ip host ns command allows a DistributedDirector to distribute the server selection process to multiple DistributedDirectors, providing greater scalability and better administrative control.
A DNS server can delegate responsibility for a domain to another DNS server by returning an NS record when queried. This task is especially useful to a DistributedDirector because determining the best DNS reply may be time consuming. To expedite replies, a DistributedDirector can return an NS record, delegating authority for the requested data to one or more second-level DistributedDirectors.
Examples
The following example shows a top-level DistributedDirector that uses the low-cost metric random to distribute its load over second-level DistributedDirectors:
Top-Level DistributedDirector
Router(config)# ip host www.xyz.com ns ns.xyz.comRouter(config)# ip host ns2.xyz.com 10.0.0.1 10.0.0.2 10.0.0.3Router(config)# ip director host ns.xyz.com priority random 1Router(config)# ip dns primary www.xyz.com soa ns2.xyz.comThe following example shows second-level DistributedDirectors that use more expensive metrics such as drp-ext and drp-rtt to perform precise server selection.
Second-Level DistributedDirector
Router(config)# ip host www.xyz.com 10.0.0.4 10.0.0.5 10.0.0.6Router(config)# ip director host www.xyz.com priority drp-ext 1Router(config)# ip director host www.xyz.com priority drp-rtt 2Router(config)# ip director server 10.0.0.4 drp-association 10.0.0.7Router(config)# ip director server 10.0.0.5 drp-association 10.0.0.8Router(config)# ip director server 10.0.0.6 drp-association 10.0.0.9ip http access-class
To specify the access list that should be used to restrict access to the HTTP server, use the ip http access-class command in global configuration mode. To remove a previously configured access list association, use the no form of this command.
ip http access-class access-list-number
no ip http access-class access-list-number
Syntax Description
access-list-number
Standard IP access list number in the range 0 to 99, as configured by the access-list global configuration command.
Command Default
No access list is applied to the HTTP server.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
If this command is configured, the specified access list is assigned to the HTTP server. Before the HTTP server accepts a connection, it checks the access list. If the check fails, the HTTP server does not accept the request for a connection.
Examples
The following example shows how to define an access list as 20 and assign it to the HTTP server:
Router(config)# ip access-list standard 20Router(config-std-nacl)# permit 209.165.202.130 0.0.0.255Router(config-std-nacl)# permit 209.165.201.1 0.0.255.255Router(config-std-nacl)# permit 209.165.200.225 0.255.255.255! (Note: all other access implicitly denied)Router(config-std-nacl)# exitRouter(config)# ip http access-class 20Related Commands
ip http accounting commands
To specify a particular command accounting method for HTTP server users, use the ip http accounting commands command in global configuration mode. To disable a configured command accounting method, use the no form of this command.
ip http accounting commands level {default | named-accounting-method-list}
no ip http accounting commands level
Command Default
Command accounting for HTTP and HTTP over Secure Socket Layer (HTTPS) is automatically enabled when authentication, authorization, and accounting (AAA) is configured on the device. It is not possible to dissable accounting for HTTP and HTTPS. HTTP and HTTPS will default to using the global AAA default method list for accounting. The CLI can be used to configure HTTP and HTTPS to use any predefined AAA method list.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The ip http accounting commands command is used to specify a particular command accounting method for HTTP server users.
Command accounting provides information about the commands for a specified privilege level that are being executed on a device. Each command accounting record corresponds to one IOS command executed at its respective privilege level, as well as the date and time the command was executed, and the user who executed it. Command accounting will be implemented for HTTP and HTTPS. A stop accounting record will be generated for any CLI execution/configuration done by a user via HTTP and HTTPS.
If this command is not configured, HTTP and HTTPS will use the default AAA accounting list whenever AAA is turned-on using aaa new-model configuration CLI. If the default method-list doesn't exist, no accounting records will be generated. Whenever AAA is not turned-on, again no accounting records will be generated.
Note
The above behavior is essential to maintain consistency of HTTP and HTTPS accounting CLI with their counterparts available for Telnet/SSH in the IOS line configuration mode.
Examples
The following example shows how to configure HTTP and HTTPS to allow AAA accounting support:
Router(config)# ip http accounting commands 1 oneacctRelated Commands
ip http active-session-modules
To selectively enable HTTP applications that will service incoming HTTP requests from remote clients, use the ip http active-session-modules command in global configuration mode. Use the no form of this command to return to the default, for which all HTTP services will be enabled.
ip http active-session-modules {listname | none | all}
no ip http active-session-modules {listname}
Syntax Description
Defaults
If no arguments or keywords are specified, all HTTP services will be enabled.
Command Modes
Global configuration
Command History
12.3(14)T
This command was introduced.
12.2(31)SB2
This command was integrated into Cisco IOS Release 12.2(31)SB2.
Usage Guidelines
Use the ip http active-session-modules command to selectively enable HTTP applications, for servicing incoming HTTP requests from remote clients. With this command, a selected list of applications can be enabled. All the applications can be enabled or none of the applications can be enabled, in other words, all disabled. Use the ip http session-module-list command to define a list of HTTP or secure HTTP (HTTPS) application names to be enabled. If an HTTP request is made for a service that is disabled, a 404 error message is displayed in the remote client browser.
Note
Examples
The following example shows how to configure a different set of services to be available for HTTP and HTTPS requests. In this example, all HTTP applications are enabled for providing services to remote clients, but for HTTPS services, only the HTTPS applications defined in list1 (Simple Certificate Enrollment Protocol [SCEP] and HOME_PAGE) are enabled.
ip http session-module-list list1 SCEP,HOME_PAGEip http active-session-modules allip http serverip http secure-serverip http secure-active-session-modules list1Related Commands
ip http authentication
To specify a particular authentication method for HTTP server users, use the ip http authentication command in global configuration mode. To disable a configured authentication method, use the no form of this command.
ip http authentication {aaa {command-authorization level listname | exec-authorization listname | login-authentication listname} | enable | local | tacacs}
no ip http authentication {aaa {command-authorization level listname | exec-authorization listname | login-authentication listname} | enable | local | tacacs}
Syntax Description
Defaults
The "enable" password is required when users (clients) connect to the HTTP server.
Three command privilege levels exist on the router.Command Modes
Global configuration (config)
Command History
Usage Guidelines
The ip http authentication command specifies the authentication method to be used for login when a client connects to the HTTP server. Use of the aaa option is recommended. The enable, local, and tacacs methods should be specified using the aaa authentication login command.
The "enable" password method is the default HTTP server authentication method. If the enable password is used as the HTTP server login authentication method, the client connects to the HTTP server with a default privilege level of 15.
Note
To configure HTTP access as part of a AAA policy, use the aaa command option. The local, tacacs, or enable authentication methods should then be configured using the aaa authentication login command.Examples
The following example shows how to specify that AAA should be used for authentication for HTTP server users. The AAA login method is configured as the "local" username/password authentication method. This example also shows how to specify using the local username database for login authentication and EXEC authorization of HTTP sessions:
Router(config)# aaa authentication login LOCALDB localRouter(config)# aaa authorization exec LOCALDB localRouter(config)# ip http authentication aaa login-authentication LOCALDBRouter(config)# ip http authentication aaa exec-authorization LOCALDBRelated Commands
ip http client cache
To configure the HTTP client cache, use the ip http client cache command in global configuration mode. To remove the specification of a value configured for the HTTP client cache, use the no form of this command.
ip http client cache {ager interval minutes | memory {file file-size-limit | pool pool-size-limit}
no ip http client cache {ager interval | memory {file | pool}}
Syntax Description
Command Default
5 second ager interval for the HTTP client cache memory pool
2 KB maximum file size supported by the HTTP client cache
100 KB maximum memory pool size for the HTTP client cacheCommand Modes
Global configuration (config)
Command History
Usage Guidelines
Use this command to specify the HTTP client cache ager interval, maximum file size, or maximum memory pool size.
To display the values configured by this command, use the show ip http client cache command.
Examples
The following example shows how to specify an HTTP client cache ager interval of 10 minutes:
Router(config)# ip http client cache ager interval 10The following example shows how to specify an HTTP client cache maximum file size of 7 KB:
Router(config)# ip http client cache memory file 7The following example shows how to specify an HTTP client cache maximum memory pool size of 55 KB:
Router(config)# ip http client cache memory pool 55Related Commands
ip http client connection
To configure an HTTP client connection to a remote HTTP server for file transfers, use the ip http client connection command in global configuration mode. To remove the configuration, use the no form of this command.
ip http client connection {forceclose | idle timeout seconds | pipeline-length length | retry count | timeout seconds}
no ip http client connection {forceclose | idle | pipeline-length | retry | timeout}
Syntax Description
Command Default
A persistent connection is enabled.
Command Modes
Global configuration (config)
Command History
Examples
The following example shows how to configure an idle connection time of 15 seconds for an HTTP client persistent connection.
Router(config)# ip http client connection idle timeout 15Related Commands
ip http client password
To configure the default password used for connections to remote HTTP servers, use the ip http client password command in global configuration mode. To remove a configured default password from the configuration, use the no form of this command.
ip http client password {0 password | 7 password | password}
no ip http client password
Syntax Description
Defaults
No default password exists for the HTTP connections.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
This command is used to configure a default password before a file is downloaded from a remote web server using the copy http:// or copy https:// command. The default password will be overridden by a password specified in the URL of the copy command.
The password is encrypted in the configuration files.
Note
Examples
In the following example, the default HTTP password is configured as Password and the default HTTP username is configured as User2 for connections to remote HTTP or HTTPS servers:
Router(config)# ip http client password PasswordRouter(config)# ip http client username User2Router(config)# do show running-config | include ip http clientRelated Commands
ip http client proxy-server
To configure an HTTP proxy server, use the ip http client proxy-server command in global configuration mode. To disable or change the proxy server, use the no form of this command.
ip http client proxy-server proxy-name proxy-port port-number]
no ip http client proxy-server
Syntax Description
Defaults
No default behavior or values
Command Modes
Global configuration (config)
Command History
Usage Guidelines
This command configures the HTTP client to connect to a remote proxy server for HTTP file system client connections.
Examples
The following example shows how to configure the HTTP proxy server named edge2 at port 29:
Router(config)# ip http client proxy-server edge2 proxy-port 29Related Commands
ip http client response
To configure the number of seconds that the HTTP client waits for a response from the server for a request message, use the ip http client response command in global configuration mode. To remove the specified number of seconds that the HTTP client waits for a response, use the no form of this command.
ip http client response timeout seconds
no ip http client response timeout
Syntax Description
timeout
Specifies a response timeout period.
seconds
The amount of time, in seconds, to wait for a response to a domain name system (DNS) query. The range is from 1 to 300.
Command Default
None
Command Modes
Global configuration (config)
Command History
Usage Guidelines
Use this command to specify the response timeout value.
Examples
The following example shows how to specify a response timeout of 180 seconds:
Router(config)# ip http client response timeout 180Related Commands
ip http client secure-ciphersuite
To specify the CipherSuite that should be used for encryption over the secure HTTP connection from the client to a remote server, use the ip http client secure-ciphersuite command in global configuration mode. To remove a previously configured CipherSuite specification for the client, use the no form of this command.
ip http client secure-ciphersuite [3des-ede-cbc-sha] [rc4-128-sha] [rc4-128-md5] [des-cbc-sha]
no ip http client secure-ciphersuite
Syntax Description
Command Default
The client and server negotiate the best CipherSuite that they both support from the list of available CipherSuites.
Command Modes
Global configuration
Command History
Usage Guidelines
This command allows you to restrict the list of CipherSuites (encryption algorithms) that the client offers when connecting to a secure HTTP server. For example, you may want to allow only the most secure CipherSuites to be used.
Unless you have a reason to specify the CipherSuites that should be used, or you are unfamiliar with the details of these CipherSuites, you should leave this command unconfigured and let the server and client negotiate the CipherSuite that they both support (this is the default). The no form of this command returns the list of available CipherSuites to the default (that is, all CipherSuites supported on your device are available for negotiation).
Examples
The following example shows how to configure the HTTPS client to use only the SSL_RSA_WITH_3DES_EDE_CBC_SHA CipherSuite:
Router(config)# ip http client secure-ciphersuite 3des-ede-cbc-shaRelated Commands
show ip http client secure status
Displays the configuration status of the secure HTTP client.
ip http client secure-trustpoint
To specify the remote certificate authority (CA) trustpoint that should be used if certification is needed for the secure HTTP client, use the ip http client secure-trustpoint command in global configuration mode. To remove a client trustpoint from the configuration, use the no form of this command.
ip http client secure-trustpoint trustpoint-name
no ip http client secure-trustpoint trustpoint-name
Syntax Description
trustpoint-name
Name of a configured trustpoint. Use the same trustpoint name that was used in the associated crypto ca trustpoint command.
Command Default
If the remote HTTPS server requests client certification, the secure HTTP client will use the trustpoint configured using the primary command in the CA trustpoint configuration. If a trustpoint is not configured, client certification will fail.
Command Modes
Global configuration
Command History
Usage Guidelines
This command specifies that the secure HTTP client should use the certificate associated with the trustpoint indicated by the trustpoint-name argument. Use the same trustpoint name that you used in the associated crypto ca trustpoint command.
The specified X.509v3 security certificate will be used by the HTTPS client for cases when the remote HTTPS server requires client authorization.
Use this command only if you have already declared a CA trustpoint using the crypto ca trustpoint command and associated submode commands. If the remote HTTPS server requires client authorization and a trustpoint is not configured for the client, the remote HTTPS server will reject the connection.
If this command is not used, the client attempts to use the certificate associated with the primary trustpoint. The primary trustpoint is configured using the primary command.
Examples
In the following example, the CA trustpoint is configured and referenced in the secure HTTP server configuration:
!The following commands specify a CA trustpoint that can be used!to obtain a X.509v3 security certificate.Router(config)# crypto ca trustpoint tp1Router(config-ca)# enrollment url http://host1:80Router(config-ca)# exit!The following command is used to actually obtain the security certificate.!A trustpoint NAME is used because there could be multiple trust points!configured for the router.Router(config)# crypto ca enrollment TP1!The following command specifies that the secure HTTP client!should use the certificate associated with the TP1 trustpoint for HTTPS connections.Router(config)# ip http client secure-trustpoint tp1Related Commands
ip http client source-interface
To configure a source interface for the HTTP client, use the ip http client source-interface command in global configuration mode. To change or disable the source interface, use the no form of this command.
ip http client source-interface type number
no ip http client source-interface
Syntax Description
Defaults
No default behavior or values
Command Modes
Global configuration (config)
Command History
Usage Guidelines
Use this command to specify a source interface to use for HTTP connections.
Examples
The following example shows how to configure the source interface as Ethernet 0/1:
Router(config)# ip http client source-interface Ethernet 0/1Related Commands
ip http client username
To configure the default username used for connections to remote HTTP servers, use the ip http client username command in global configuration mode. To remove a configured default HTTP username from the configuration, use the no form of this command.
ip http client username username
no ip http client username
Syntax Description
username
String that is the username (login name) to be used in HTTP client connection requests sent to remote HTTP servers.
Defaults
No default username exists for the HTTP connections.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
This command is used to configure a default username before a file is copied to or from a remote web server using the copy http:// or copy https:// command. The default username will be overridden by a username specified in the URL of the copy command.
Note
Examples
In the following example, the default HTTP password is configured as Secret and the default HTTP username is configured as User1 for connections to remote HTTP or HTTPS servers:
Router(config)# ip http client password SecretRouter(config)# ip http client username User1Related Commands
ip http digest algorithm
To configure the digest algorithm parameter, use the ip http digest algorithm command in global configuration mode.
ip http digest algorithm [digest-algorithm]
Syntax Description
digest-algorithm
(Optional) The digest algorithm method. The choices for the digest algorithm parameter are MD5 and MD5-sess. MD5 is the default.
Command Default
The digest algorithm parameter is set to MD5.
Command Modes
Global configuration (config)
Command History
Examples
The following example shows how to change the digest algorithm parameter from MD5 to MD5-sess:
Device(config)# ip http digest algorithm md5-sessip http help-path
To configure the help root used to locate help files for use by the user's current GUI screen, use the ip http help-path command in global configuration mode.
ip http help-path url
Syntax Description
Command Default
No URL is specified.
Command Modes
Global configuration
Command History
Usage Guidelines
The URL specified in this command must be populated with `help' files with read access that are appropriate for the application that will be using the URL.
Examples
In the following example, the HTML files are located in the specified location on the system:
Router(config)# ip http help-path http://www.cisco.com/warp/public/779/smbiz/prodconfig/help/eag/ivory/1100Related Commands
ip http server
Enables the HTTP server, including the Cisco web browser user interface.
show ip http-help path
Displays the IP HTTP help-path URL.
ip http max-connections
To configure the maximum number of concurrent connections allowed for the HTTP server, use the ip http max-connections command in global configuration mode. To return the maximum connection value to the default, use the no form of this command.
ip http max-connections value
no ip http max-connections
Syntax Description
value
An integer in the range from 1 to 16 that specifies the maximum number of concurrent HTTP connections. The default is 5.
Command Default
Five concurrent HTTP connections is the default.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
Platform-specific implementations can supersede the upper range limit of 16.
If a new value is configured that is less than the previously configured value while the current number of connections exceeds the new maximum value, the HTTP server will not abort any of the current connections. However, the server will not accept new connections until the current number of connections falls below the new configured value.
Examples
The following example shows how to configure the HTTP server to allow up to 10 simultaneous connections:
Router(config)# ip http serverRouter(config)# ip http max-connections 10Related Commands
ip http server
Enables the HTTP 1.1 server, including the Cisco web browser user interface.
ip http path
To specify the base path used to locate files for use by the HTTP server, use the ip http path command in global configuration mode. To remove the base path specification, use the no form of this command.
ip http path url
no ip http path
Syntax Description
url
Cisco IOS File System (IFS) URL specifying the location of the HTML files used by the HTTP server.
Command Default
The HTTP server is disabled.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
After enabling the HTTP server, you should set the base path by specifying the location of the HTML files to be served. HTML files used by the HTTP web server typically reside in system flash memory.
Remote URLs can be specified using this command, but use of remote path names (for example, where HTML files are located on a remote TFTP server) is not recommended.
Examples
In the following example, the HTML files are located in the default flash location on the system:
Router(config)# ip http path flash:In the following example, the HTML files are located in the directory named web on the flash memory card inserted in slot 0:
Router(config)# ip http path slot0:webRelated Commands
ip http server
Enables the HTTP server, including the Cisco web browser user interface.
ip http port
To specify the port number to be used by the HTTP server, use the ip http port command in global configuration mode. To return the port number to the default, use the no form of this command.
ip http port port-number
no ip http port
Syntax Description
port-number
The integer 80 or any integer in the range from 1025 to 65535 that specifies the port number to be used for the HTTP server. The default is 80.
Command Default
The HTTP server uses port 80.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
HTTP port 80 is the standard port used by web servers.
Note
Examples
The following example shows how to change the HTTP server port to port 8080:
Router(config)# ip http serverRouter(config)# ip http port 8080Related Commands
ip http server
Enables the HTTP 1.1 server, including the Cisco web browser user interface.
ip http secure-active-session-modules
To selectively activate HTTP Secure (HTTPS) services to process incoming HTTPS requests from remote clients, use the ip http secure-active-session-modules command in global configuration mode. To return to the default in which all HTTPS services are activated, use the no form of this command.
ip http secure-active-session-modules {listname | all | none}
no ip http secure-active-session-modules
Syntax Description
listname
List of specifically configured HTTPS services to activate.
all
Activates all HTTPS services.
none
Deactivates all HTTPS services.
Command Default
All HTTPS services are activated.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
Use the ip http secure-active-session-modules command to activate or deactivate HTTPS services to process incoming HTTPS requests from remote clients. Use the ip http session-module-list command to define a list of HTTP or HTTPS services to be enabled.
If an HTTPS request is made for a service that is disabled, an error message is displayed in the remote client browser.
Examples
The following example shows how to configure different sets of services to be available for HTTP and HTTPS requests. In this example, all HTTP services are activated, but only the HTTPS services defined in list1 (Simple Certificate Enrollment Protocol [SCEP] and HOME_PAGE) are activated.
ip http session-module-list list1 SCEP,HOME_PAGEip http active-session-modules allip http serverip http secure-serverip http secure-active-session-modules list1Related Commands
ip http secure-ciphersuite
To specify the CipherSuites that should be used by the secure HTTP server when negotiating a connection with a remote client, use the ip http secure-ciphersuite command in global configuration mode. To return the configuration to the default set of CipherSuites, use the no form of this command.
ip http secure-ciphersuite [3des-ede-cbc-sha] [rc4-128-sha] [rc4-128-md5] [des-cbc-sha]
no ip http secure-ciphersuite
Syntax Description
Command Default
The HTTPS server negotiates the best CipherSuite using the list received from the connecting client.
Command Modes
Global configuration
Command History
Usage Guidelines
This command is used to restrict the list of CipherSuites (encryption algorithms) that should be used for encryption over the HTTPS connection. For example, you may want to allow only the most secure CipherSuites to be used.
Unless you have a reason to specify the CipherSuites that should be used, or you are unfamiliar with the details of these CipherSuites, you should leave this command unconfigured and let the server and client negotiate the CipherSuite that they both support (this is the default).
The supported CipherSuites vary by Cisco IOS software image. For example, "IP Sec56" ("k8") images support only the SSL_RSA_WITH_DES_CBC_SHA CipherSuite in Cisco IOS Release 12.2(15)T.
In terms of router processing load (speed), the following list ranks the CipherSuites from fastest to slowest (slightly more processing time is required for the more secure and more complex CipherSuites):
1.
2.
3.
4.
Additional information about these CipherSuites can be found online from sources that document the Secure Sockets Layer (SSL) 3.0 protocol.
Examples
The following exampleshows how to restrictsthe CipherSuites offered to a connecting secure web client:
Router(config)# ip http secure-ciphersuite rc4-128-sha rc4-128-md5Related Commands
ip http secure-server
Enables the HTTPS server.
show ip http server secure status
Displays the configuration status of the secure HTTP server.
ip http secure-client-auth
To configure the secure HTTP server to authenticate connecting clients, use the ip http secure-client-auth command in global configuration mode. To remove the requirement for client authorization, use the no form of this command.
ip http secure-client-auth
no ip http secure-client-auth
Syntax Description
This command has no arguments or keywords.
Command Default
Client authentication is not required for connections to the secure HTTP server.
Command Modes
Global configuration
Command History
Usage Guidelines
This command configures the HTTP server to request an X.509v3 certificate from the client in order to authenticate the client during the connection process.
In the default connection and authentication process, the client requests a certificate from the HTTP server, but the server does not attempt to authenticate the client. Authenticating the client provides more security than server authentication by itself, but not all web clients may be configured for certificate authority (CA) authentication.
Examples
In the following example the secure web server is enabled and the server is configured to accept connections only from clients with a signed security certificate:
Router(config)# no ip http serverRouter(config)# ip http secure-serverRouter(config)# ip http secure-client-authRelated Commands
ip http secure-server
Enables the HTTPS server.
show ip http server secure status
Displays the configuration status of the secure HTTP server.
ip http secure-port
To set the secure HTTP (HTTPS) server port number for listening, use the ip http secure-port command in global configuration mode. To return the HTTPS server port number to the default, use the no form of this command.
ip http secure-port port-number
no ip http secure-port
Syntax Description
port-number
Integer in the range of 0 to 65535 is accepted, but the port number must be higher than 1024 unless the default is used. The default is 443.
Command Default
The HTTPS server port number is not set for listening.
Command Modes
Global configuration
Command History
Usage Guidelines
An HTTP server and an HTTPS server cannot use the same port. If you try to configure both on the same port, the following message is displayed:
% Port port_number in use by HTTP.where port_number is the port number that is already assigned to the HTTP server.
If you change the HTTPS port number, clients attempting to connect to the HTTPS server must specify the port number in the URL, in this format:
https://device:port_number
where port_number is the HTTPS port number.
Examples
The following example shows how to assign port 1025 for HTTPS server connections:
Router(config)# ip http secure-port 1025Related Commands
ip http secure-server
To enable a secure HTTP (HTTPS) server, use the ip http secure-server command in global configuration mode. To disable an HTTPS server, use the no form of this command.
ip http secure-server
no ip http secure-server
Syntax Description
This command has no arguments or keywords.
Command Default
The HTTPS server is disabled.
Command Modes
Global configuration
Command History
Usage Guidelines
The HTTPS server uses the Secure Sockets Layer (SSL) version 3.0 protocol.
Note
If a certificate authority (CA) is used for certification, you should declare the CA trustpoint on the routing device before enabling the HTTPS server.
Examples
In the following example the HTTPS server is enabled, and the (previously configured) CA trustpoint CA-trust-local is specified:
Router# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# ip http secure-serverRouter(config)# ip http secure-trustpoint CA-trust-localRouter(config)# endRouter# show ip http server secure status
HTTP secure server status: Enabled
HTTP secure server port: 443
HTTP secure server ciphersuite: 3des-ede-cbc-sha des-cbc-sha rc4-128-md5 rc4-12a
HTTP secure server client authentication: Disabled
HTTP secure server trustpoint: CA-trust-localRelated Commands
ip http secure-trustpoint
To specify the certificate authority (CA) trustpoint that should be used for obtaining signed certificates for a secure HTTP (HTTPS) server, use the ip http secure-trustpoint command in global configuration mode. To remove a previously specified CA trustpoint, use the no form of this command.
ip http secure-trustpoint trustpoint-name
no ip http secure-trustpoint trustpoint-name
Syntax Description
trustpoint-name
Name of a configured trustpoint. Use the same trustpoint name that was used in the associated crypto ca trustpoint command.
Command Default
The HTTPS server uses the trustpoint configured when you use the primary command. If a trustpoint is not configured, the HTTPS server uses a self-signed certificate.
Command Modes
Global configuration
Command History
Usage Guidelines
This command specifies that the HTTPS server should use the X.509v3 certificate associated with the trustpoint indicated by the trustpoint-name argument. Use the same trustpoint name that you used in the associated crypto ca trustpoint command.
The specified X.509v3 security certificate will be used to authenticate the server to connecting clients, and, if remote client authentication is enabled, to authenticate the connecting clients.
Use this command only if you have already declared a CA trustpoint using the crypto ca trustpoint command and associated submode commands. If a trustpoint is not configured, the HTTPS server will use a self-signed certificate.
If this command is not used, the server will attempt to use the certificate associated with the primary trustpoint. The primary trustpoint is configured using the primary command.
Examples
In the following example, the CA trustpoint is configured, a certificate is obtained, and the certificate is referenced in the HTTPS server configuration:
!The following commands specifies a CA trustpoint that can be used!to obtain a X.509v3 security certificate.!A trustpoint NAME is used because there could be multiple trustpoints!configured for the router.Router(config)# crypto ca trustpoint tp1Router(config-ca)# enrollment url http://host1:80Router(config-ca)# exitRouter(config)# crypto ca authenticate tp1!The following command is used to actually obtain the security certificate.Router(config)# crypto ca enrollment tp1Router(config)# ip http secure-server!The following command specifies that the secure HTTP server!should use a certificate associated with the TP1 trustpoint for HTTPS connections.Router(config)# ip http secure-trustpoint tp1Related Commands
ip http server
To enable the HTTP server on your IP or IPv6 system, including the Cisco web browser user interface, use the ip http server command in global configuration mode. To disable the HTTP server, use the no form of this command.
ip http server
no ip http server
Syntax Description
This command has no arguments or keywords.
Command Default
The HTTP server is disabled on the Cisco Catalyst 4000 series switch. The HTTP server is enabled for clustering on the following Cisco switches: Catalyst 3700 series, Catalyst 3750 series, Catalyst 3550 series, Catalyst 3560 series, and Catalyst 2950 series.
The HTTP server uses the standard port 80 by default.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
With IPv6 support added in Cisco IOS Release 12.2(2)T, the ip http server command simultaneously enables and disables both IP and IPv6 access to the HTTP server. However, an access list configured with the ip http access-class command will only be applied to IPv4 traffic. IPv6 traffic filtering is not supported.
Caution
Examples
The following example shows how to enable the HTTP server on both IP and IPv6 systems:
Router(config)# ip http serverRouter(config)# ip http path flash:Related Commands
ip http session-module-list
To define a list of HTTP or secure HTTP (HTTPS) application names, use the ip http session-module-list command in global configuration mode. To remove the defined list, use the no form of this command.
ip http session-module-list listname prefix1 [prefix2,...,prefixn]
no ip http session-module-list listname prefix1 [prefix2,...,prefixn]
Syntax Description
Defaults
No list of HTTP or HTTPS application names is defined.
Command Modes
Global configuration
Command History
12.3(14)T
This command was introduced.
12.2(31)SB2
This command was integrated into Cisco IOS Release 12.2(31)SB2.
Usage Guidelines
Use this command to define a list of HTTP or HTTPS application names. The defined list can then be used by the ip http active-session-modules or ip http secure-active-session-modules commands to selectively enable HTTP or HTTPS applications, respectively, for servicing incoming HTTP and HTTPS requests from remote clients.
When defining a list of HTTP or HTTPS application names, use the following guidelines:
•
•
•
•
Note
Examples
The following example shows how to configure a different set of services to be available for HTTP and HTTPS requests. In this example, all HTTP applications are enabled for providing services to remote clients, but for HTTPS services, only the HTTPS applications defined in list1 (Simple Certificate Enrollment Protocol [SCEP] and HOME_PAGE) are enabled.
ip http session-module-list list1 SCEP,HOME_PAGEip http active-session-modules allip http serverip http secure-serverip http secure-active-session-modules list1Related Commands
ip http timeout-policy
To configure the parameters for closing connections to the local HTTP server, use the ip http timeout-policy command in global configuration mode. To return the parameters to their defaults, use the no form of this command.
ip http timeout-policy idle seconds life seconds requests value
no ip http timeout-policy
Syntax Description
Defaults
HTTP server connection idle time: 180 seconds (3 minutes)
HTTP server connection life time: 180 seconds (3 minutes)
HTTP server connection maximum requests: 1
Command Modes
Global configuration (config)
Command History
Usage Guidelines
This command sets the characteristics that determine how long a connection to the HTTP server should remain open.
This command may not take effect immediately on any HTTP connections that are open at the time you use this command. In other words, new values for idle time, life time, and maximum requests will apply only to connections made to the HTTP server after this command is issued.
A connection may be closed sooner than the configured idle time if the server is too busy or the limit on the life time or the number of requests is reached.
Also, since the server will not close a connection while actively processing a request, the connection may remain open longer than the specified life time if processing is occurring when the life maximum is reached. In this case, the connection will be closed when processing finishes.
A connection may be closed before the maximum number of requests are processed if the server is too busy or the limit on the idle time or life time is reached.
The ip http timeout-policy command allows you to specify a general access policy to the HTTP server by adjusting the connection timeout values. For example, if you want to maximize throughput for HTTP connections, you should configure a policy that minimizes connection overhead. You can do this by specifying large values for the life and requests options so that each connection stays open longer and more requests are processed for each connection.
Another example would be to configure a policy that minimizes the response time for new connections. You can do this by specifying small values for the life and requests options so that the connections are quickly released to serve new clients.
A throughput policy would be better for HTTP sessions with dedicated management applications, as it would allow the application to send more requests before the connection is closed, while a response time policy would be better for interactive HTTP sessions, as it would allow more people to connect to the server at the same time without having to wait for connections to become available.
In general, you should configure these options as appropriate for your environment. The value for the idle option should be balanced so that it is large enough not to cause an unwanted request or response timeout on the connection, but small enough that it does not hold a connection open longer than necessary.
Examples
In the following example, a Throughput timeout policy is applied. This configuration would allow each connection to be idle for a maximum of 30 seconds (approximately). Each connection will remain open (be "alive") until either the HTTP server has been busy processing requests for approximately 2 minutes (120 seconds) or until approximately 100 requests have been processed.
Router(config)# ip http timeout-policy idle 30 life 120 requests 100In the following example, a Response Time timeout policy is applied. This configuration would allow each connection to be idle for a maximum of 30 seconds (approximately). Each connection will be closed as soon as the first request has been processed.
Router(config)# ip http timeout-policy idle 30 life 30 requests 1Related Commands
ip http server
Enables the HTTP server, including the Cisco web browser user interface.
keepalive (WSMA)
To enable keepalive messages and configure interval and retry values for a Web Services Management Agent (WSMA) profile, use the keepalive command in WSMA listener configuration mode or WSMA initiator configuration mode. To disable keepalive messages, use the no form of this command.
keepalive interval [retries number]
no keepalive
Syntax Description
Command Default
Keepalive messages are not sent.
Command Modes
WSMA initiator configuration (config-wsma-init)
WSMA listener configuration (config-wsma-listen)
Command History
Usage Guidelines
WSMA initiator profiles using the HTTP or HTTPs protocol must be configured to send keepalive messages. This ensures that the Cisco IOS device allows the remote WSMA application to send WSMA requests.
Keepalive messages are not sent from WSMA listener connections that use the HTTP or HTTPs protocol because of the directional nature of HTTP transactions. Only the HTTP client can send requests on an HTTP connection.
Note
Examples
The following example shows how to enable keepalive messages and configure interval and retry values for a WSMA initiator profile :
Router(config)# wsma profile initiator prof1Router(config-wsma-init)# keepalive 200 retries 20Related Commands
kron occurrence
To specify schedule parameters for a Command Scheduler occurrence and enter kron-occurrence configuration mode, use the kron occurrence command in global configuration mode. To delete a Command Scheduler occurrence, use the no form of this command.
kron occurrence occurrence-name [user username] {in [[numdays:] numhours:] nummin | at hours:min [[month] day-of-month] [day-of-week]} {oneshot | recurring | system-startup}
no kron occurrence occurrence-name [user username] {in [[numdays:] numhours:] nummin | at hours:min [[month] day-of-month] [day-of-week]} {oneshot | recurring | system-startup}
Syntax Description
Command Default
No schedule parameters are specified.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
Prior to Cisco IOS Release 12.4, when you configured a kron occurrence for a calendar time when the system clock was not set, you received a printf message stating that the clock was not set and the occurrence would not be scheduled until it was set.
Beginning in Cisco IOS Release 12.4, when you configure a kron occurrence for a calendar time when the system clock is not set, the occurrence is scheduled but a printf message appears stating that the clock is not set and that it currently reads <current clock time>.
If you set the clock, the schedule of the occurrence is affected in one of the following ways:
•
•
•
•
Use the kron occurrence and policy-list commands to schedule one or more policy lists to run at the same time or interval.
Use the kron policy-list command in conjunction with the cli command to create a Command Scheduler policy containing EXEC command-line interface (CLI) commands to be scheduled to run on the router at a specified time.
Use the show kron schedule command to display the name of each configured occurrence and when it will next run.
The Command Scheduler process is useful to automate the running of EXEC commands at recurring intervals, and it can be used in remote routers to minimize manual intervention.
Examples
The following example shows how to create a Command Scheduler occurrence named info-three and schedule it to run every three days, 10 hours, and 50 minutes. The EXEC CLI in the policy named three-day-list is configured to run as part of occurrence info-three.
Router(config)# kron occurrence info-three user IT2 in 3:10:50 recurringRouter(config-kron-occurrence)# policy-list three-day-listThe following example shows how to create a Command Scheduler occurrence named auto-mkt and schedule it to run once on June 4 at 5:30 a.m. The EXEC CLI in the policies named mkt-list and mkt-list2 are configured to run as part of occurrence auto-mkt.
Router(config)# kron occurrence auto-mkt user marketing at 5:30 jun 4 oneshotRouter(config-kron-occurrence)# policy-list mkt-listRouter(config-kron-occurrence)# policy-list mkt-list2Related Commands
kron policy-list
To specify a name for a Command Scheduler policy and enter kron-policy configuration mode, use the kron policy-list command in global configuration mode. To delete the policy list, use the no form of this command.
kron policy-list list-name
no kron policy-list list-name
Syntax Description
Command Default
If the specified list name does not exist, a new policy list is created.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
Use the kron policy-list command in conjunction with the cli command to create a Command Scheduler policy containing EXEC command-line interface (CLI) commands to be scheduled to run on the router at a specified time. Use the kron occurrence and policy-list commands to schedule one or more policy lists to run at the same time or interval.
When the list-name is new, a policy list structure is created. When the list-name is not new, the existing policy list is edited.
The Command Scheduler process is useful to automate the running of EXEC commands at recurring intervals, and it can be used in remote routers to minimize manual intervention.
Examples
The following example shows how to create a policy named sales-may and configure EXEC CLI commands to run the CNS command that retrieves an image from a server:
Router(config)# kron policy-list sales-mayRouter(config-kron-policy)# cli cns image retrieve server https://10.21.2.3/imgsvr/ status https://10.21.2.5/status/Related Commands
