UIDH Server Configuration Mode Commands

The UIDH Server Configuration Mode commands are used to configure the parameters when a connection is established with the UIDH Server.

Mode

Exec > Global Configuration > Context Configuration > UIDH Server Configuration Mode Configuration

configure > context context_name > uidh-server uidh_server_name

Entering the above command sequence results in the following prompt:

[context_name]host_name(uidh-server)#

end

Exits the current configuration mode and returns to the Exec mode.

Product

All

Privilege

Security Administrator, Administrator

Syntax

end

Usage Guidelines

Use this command to return to the Exec mode.

exit

Exits the current mode and returns to the parent configuration mode.

Product

All

Privilege

Security Administrator, Administrator

Syntax

exit

Usage Guidelines

Use this command to return to the parent configuration mode.

refresh-interval

This command allows you to configure the refresh interval for a UIDH key.

Product

P-GW

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > Context Configuration > UIDH Server Configuration Mode Configuration

configure > context context_name > uidh-server uidh_server_name

Entering the above command sequence results in the following prompt:

[context_name]host_name(uidh-server)#

Syntax

refresh-interval refresh_interval_time 
default refresh-interval 
no refresh-interval

no

Deletes the refresh interval parameter from the UIDH server configuration.

default

Configures the default interval value in the UIDH server configuration.

refresh_interval_time

The refresh interval time is configured in hours and is an integer ranging from 8 to 168 hours. The default interval value is 8 hours.

Usage Guidelines

Use this command to configure the refresh interval in the UIDH sever configuration.

When a session is attached to P-GW, the P-GW queries the UIDH server. If there is no response from the UIDH server, the UIDH service is not enabled for this session. If there is a Whitelisted subscriber, the UIDH server sends the UIDH string to P-GW. The P-GW queries the UIDH string after the refresh interval.

  • On querying, if P-GW does not receive a response, it uses the existing key and sends another request after the refresh interval.

  • If P-GW receives a response with an empty string – subscriber moving from OPT-IN to OPT-OUT, it does not perform a key refresh and UIDH insertion is disabled until the subscriber re-attaches.

  • Any status change of a subscriber from OPT-OUT to OPT-IN is applied only on subscriber attach. However, the status changes from OPT-IN to OPT-OUT is applied only after refresh interval.

  • When a subscriber moves to the OPT-OUT status, it is indicated with the following response: 200 OK Blank Response. This indicates that the request has been processed successfully at the UIDH server and that the subscriber has opted out.

In case of UIDH service failure, either because of a failure in service or because of failure in connection to the UIDH server, the P-GW continues to process the session without inserting the UIDH hash value.

Examples

The following command sets the refresh interval in the UIDH server as 6 hours:: 
refresh-interval 6

remote-address

This command allows you to configure the remote address of the UIDH server.

Product

P-GW

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > Context Configuration > UIDH Server Configuration Mode Configuration

configure > context context_name > uidh-server uidh_server_name

Entering the above command sequence results in the following prompt:

[context_name]host_name(uidh-server)#

Syntax

remote-address uidh_address port uidh_port_number local-address local_address 
no remote-address

no

Deletes the remote address configuration from the UIDH Server.

port

Configures the remote port address to connect to the UIDH server. The port address is an integer ranging from 1 to 65535.

local-address

Configures a local IP address (IPv4/IPv6) to be used to connect to a UIDH server.

Usage Guidelines

Use this command to configure the remote address of the UIDH server.

Examples

The following command sets the remote address as 1.1.1.1, port number as 600 and local address as 2.2.2.2: 
remote-address 1.1.1.1 port 600 local-address 2.2.2.2

response-timeout

This command allows you to configure the response timeout for UIDH requests.

Product

P-GW

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > Context Configuration > UIDH Server Configuration Mode Configuration

configure > context context_name > uidh-server uidh_server_name

Entering the above command sequence results in the following prompt:

[context_name]host_name(uidh-server)#

Syntax

response-timeout timeout_value 
default refresh-interval 
no remote-address

no

Deletes the response timeout configuration for UIDH requests.

default

Configures the default response timeout value for UIDH requests.

response_timeout

The timeout value is configured in seconds and is an integer ranging from 1 to 10. The default timeout value is 2 seconds.

Usage Guidelines

Use this command to configure the response timeout value for UIDH requests.

Examples

The following command sets the response timeout value as 10 seconds in the UIDH requests: 
response-timeout 10