Settings

Use SSL

Select this option to use the SSL.

Security Profile

Min Connections Per Destination

Specify the minimum number of connections towards an endpoint (identified by host:port) that the agent will try to maintain. A value of 0 indicates "no minimum". This is not a hard limit as there could be more connections created during the spike in traffic. For more details see Algorithm for Minimum Connections.

Min Connections Per Destination Check Interval (s)

Specify how often you wish to check the established connections. A value of 0 indicates "no check will be performed". After each interval, the agent will try to create additional connections to achieve number set in the Min Connections Per Destination parameter. No connections will be shut down if the current number of connections is greater than the number set in Min Connections Per Destination. For more details, see Algorithm for Minimum Connections.

Default connection concurrent streams

The initial value of concurrent streams that the client would like to handle per connection. The default value is 1000.

Timeout

Request Timeout (sec)

Enter the timeout period in seconds for the request to the HTTP/2 client to wait for a response before timing out.

Queue Settings

Max Requests Queued Per Destination

The size of the message queue in the Jetty server. The default value is 20000.

Retry Interval For full Queues (ms)

A millisecond value to indicate the time it will take for the request to try again when the queue is full.

Max Retries For Full Queue

When the Route Error UDR option is checked, this field will be enabled. This field will indicate how many times the request will attempt to retry before routing it to Error UDR.

Route Error UDR

if this option is selected, the request will attempt to be received by the agent until it reached the maximum amount of retries. Once the threshold is reached, the request will be stored in an Error UDR and sent as an output from the HTTP/2 client agent. If this option is not selected, the request will attempt the retries for an indefinite amount of time, until the workflow is terminated.

Server Monitor

Use HTTP2 Server Monitor

Select this option to monitor the connection status of all servers that the agent has sent requests to. The monitoring is done by sending regular ping messages to the servers. If the servers are not responding, or there are other communication errors, they will be indicated as Unavailable. A list of the Available and Unavailable servers are available in two MIM values: Available Servers and Unreachable Servers.

Ping Interval (s)

Define the ping message interval for the Server Monitor. The time unit is seconds and 10 seconds is default.

Use OpenAPI Profile

Select this option if you want the agent to use the OpenAPI profile(s).

OpenAPI Profile

Browse and select the profile to be used. This field is enabled when the Use OpenAPI Profile option is selected.

Click Browse to search for the available OpenAPI profiles.

Enable Validation

Select this option if you want to validate the OpenAPI profile.

Username

Enter a username for an account on the remote server. The username must not include colon (:) characters.

Password

Enter the password associated with the username.

Grant Type

Select the grant type:

• Client Credentials
  The agent fetches the access token from the Access Token URI during initialization, using client id and client secret for basic authentication. The credentials are base64 encoded and sent in the header of the request.
  The response contains an access token, which is then used in subsequent requests.

• Resource Owner Password Credentials

  The agent fetches the access token from the Access Token URI during initialization, using the following credentials for authentication:

  • Client ID

  • Client Secret

  • Username

  • Password

  The credentials are sent in the request body. The response contains an access token, which is then used in subsequent requests. 

Client Authentication Type

Select the client authentication method:

• client_secret_basic - The credentials are encoded in base64 and sent in the request header.

• client_secret_post - The credentials are sent in the request body.

Client ID

Enter the unique client identifier issued by the authorization server.

Client Secret

Enter the client's secret.

Username

Enter the resource owner username, this can be the end-user granting access to a protected resource. This field is required when you have selected Resource Owner Password Credentials from the drop-down list Grant Type.

Password

Enter the password associated with the username. This field is required when you have selected Resource Owner Password Credentials from the drop-down list Grant Type.

Access Token URI

Enter the URI where the access token can be obtained.

Base URL Field

Some authentication servers may provide a base URL in the response body that the HTTP/2 client agent must use for subsequent requests.

If applicable, specify the key name in the JSON formatted string where the base URL is located. The value extracted from the response will override the host field of the RequestCycle UDR configured in the APL.

In the following example, the base URL is available in instance_url.

Example - Base URL in response from authentication server

Token expiration override (sec)

Enter a time in seconds when you would like to refresh the access token prior to the expiration. This allows the application to obtain a new access token without the user's interaction. 

Additional Parameters

Some authentication servers may require additional parameters in the body of the token requests. To add a parameter, click the Add button and then enter the name of the parameter in the Key field and the value of the parameter in the Value field.

Do not use escape characters in the value field, these will be added automatically by the HTTP2 Client agent. For instance, "https://example.com/" will be sent as "https%3A%2F%2example.com%2F".

Authorization Server (NRF)

Enter the full URL path for the authorization server. If you enter an https URL, you must select the checkbox Use SSL.

Use SSL

If you want to use encryption, select this checkbox.

Security Profile

If you prefer to use a secure connection, click Browse to select a security profile with certificate and configuration. Refer to Security Profile for more information.

NF Instance ID

Enter the NF instance ID of the server that you want to send requests from.

Scope

Enter a string for the service(s) that you want to use, separated by whitespaces.

Optional Parameters

NF Type

The NF type available for selection is CHF (charging function). If you select this setting, you must also select the Target NF Type.

This is included in an access token request for an NF Type but not for a specific NF/NF service instance.

Target NF Instance ID

Enter the NF instance ID of the server for which the access token is requested.

This is included in an access token request for a specific NF service provider and shall contain NF Instance ID of the specific NF service provider. 

Target NF Type

The NF type available for selection is CHF (charging function). If you select this setting, you must also select NF Type.

This is included in an access token request for an NF Type but not for a specific NF/NF service instance.

Requester FQDN

Enter the Requester FQDN (Fully Qualified Domain Name). This is used by the NRF (Network Repository Function) to validate that the requester NF service consumer is allowed to access the target NF service provider.

Target NF Set ID

Enter the Target NF Set ID of the consumer profile. This is included in the access token request of the NF type.

Target NF Service Set ID

Enter the Target NF Service Set ID of the consumer profile. This is used by the NRF (Network Repository Function) to validate that the requester NF service consumer is allowed to access the target NF service instance.

Hnrf Access Token URI

Enter the Hnrf URI where the access token can be obtained.

Source NF Instance ID

Enter the Source NF Instance ID of the service provider. This contains the NF Instance ID of the source NF to collect data from the NF service provider. 

Requester PLMN

HTTP/2 Client Agent Configuration - NNRF Access Token authentication type (Requester PLMN)

PLMN ID

MCC

Enter the mobile country code (MCC) for the Requester PLMN (Public Land Mobile Network) ID If you enter values for the PLMN ID, you must enter values for the Target PLMN ID - MCC.

MNC

Enter the mobile network code (MNC) for the Requester PLMN (Public Land Mobile Network) ID. If you enter values for the PLMN ID, you must enter values for the Target PLMN ID - MNC.

Customize Format

Select this option to enter customized formats for the Requester PLMN ID. The supported format is JSON. 

For more information, refer to 3GPP TS 29.510 Technical Specification.

Target PLMN

HTTP/2 Client Agent Configuration - NNRF Access Token authentication type (Target PLMN)

Target PLMN ID

MCC

Enter the mobile country code (MCC) for the Target PLMN (Public Land Mobile Network) ID. This value is required if you have opted to enter the value for Requester PLMN ID - MCC.

MNC

Enter the mobile network code (MNC) for the Target PLMN (Public Land Mobile Network) ID. This value is required if you have opted to enter the value for Requester PLMN ID - MNC.

Customize Format

Select this option to enter customized formats for the Target PLMN ID. The supported format is JSON. 

For more information, refer to 3GPP TS 29.510 Technical Specification.

Target SNPN

HTTP/2 Client Agent Configuration - NNRF Access Token authentication type (Target SNPN)

MCC

Enter the mobile country code (MCC) for the Target SNPN (Standalone Non-Public Network).

MNC

Enter the mobile network code (MNC) for the Target SNPN (Standalone Non-Public Network).

NID

Enter the network identifier (NID) for the Target SNPN (Standalone Non-Public Network).

Customize Format

Select this option to enter customized formats for the Target SNPN. The supported format is JSON. 

For more information, refer to 3GPP TS 29.510 Technical Specification.

Requester S-NSSAI List

HTTP/2 Client Agent Configuration - NNRF Access Token authentication type (Requester S-NSSAI List)

S-NSSAI List

Enter the Requester S-NSSAI(s) (Single Network Slice Selection Assistance Information) of the service provider. 

This is included during an access token request for an NF type and not for a specific NF / NF service instance.

Customize Format

Select this option to enter customized formats for the Requester S-NSSAI list. The supported format is JSON. 

For more information, refer to 3GPP TS 29.510 Technical Specification.

Target S-NSSAI List

HTTP/2 Client Agent Configuration - NNRF Access Token authentication type (Target S-NSSAI List)

Target S-NSSAI list

Enter the Target S-NSSAI(s) (Single Network Slice Selection Assistance Information) of the service provider. This list may be included for NF type access token request but not for a specific NF/NF service instance. 

Customize Format

Select this option to enter customized formats for the Target S-NSSAI list. The supported format is JSON. 

For more information, refer to 3GPP TS 29.510 Technical Specification.

Requester PLMN List

HTTP/2 Client Agent Configuration - NNRF Access Token authentication type (Requester PLMN List)

PLMN List

Enter the Requester PLMN (Public Land Mobile Network) of the service producer. 

Customize Format

Select this option to enter customized formats for the Requester PLMN list. The supported format is JSON. 

For more information, refer to 3GPP TS 29.510 Technical Specification.

Requester SNPN List

HTTP/2 Client Agent Configuration - NNRF Access Token authentication type (Requester SNPN List)

SNPN List

Enter the Requester SNPN (Standalone Non-Public Network) of the service producer. 

Customize Format 

Select this option to enter customized formats for the Requester SNPN list. The supported format is JSON. 

For more information, refer to 3GPP TS 29.510 Technical Specification.

Target NSI List

HTTP/2 Client Agent Configuration - NNRF Access Token authentication type (Target NSI List)

Target NSI list

Enter the target NSI(s) (Network Slice Instances). This list may be included for NF type access token request but not for a specific NF/NF service instance. 

Customize Format

Select this option to enter customized formats for the Target NSI list. The supported format is JSON. 

For more information, refer to 3GPP TS 29.510 Technical Specification.