Configuring the REST Endpoints
This section describes how to configure the IP address, port numbers, and other attributes for a REST endpoint.
Note | Configuration changes to the REST endpoint cause the endpoint to restart automatically. Cisco recommends making such changes only within the maintenance window. |
Before configuring the external IP addresses for the PCF REST endpoints, make sure that you configure and deploy the IP addresses using the SMI Deployer.
For a single interface both IPv4 or IPv6 address can be used.
To configure REST endpoint, use the following configuration in the Policy Ops Center console:
config
rest-endpoint
interface [ n5 | n7 | n15 | n25 | n28 | nnrf ]
ip
ipv6 interface_ipv6_address
port interface_port_number
ips ip_address
port port_number
http-connection-limit maximum_inbound_connection_count
http-idle-connection-timeout-on-server-seconds idle_connection_timeout
replicas replica_count
inbound-request-timeout-ms inbound_timeout
outbound-request-timeout-ms outbound_timeout
repository repository_address
tracing-service-name tracing_service
uri-scheme uri_scheme
end
NOTES:
-
For each REST endpoint, use a separate rest-endpoint ip_address command.
-
interface [ n5 | n7 | n15 | n25 | n28 | nnrf ] —Specify the interface name and IP address that is configured for the external IP. interface_name ip_address must include the interface name such as N7, N36, N28, and NNRF.
-
ip interface_ip_address —Specify the IPv4 address that is assigned for the interface.
-
ipv6 interface_ipv6_address —Specify the IPv6 address that is assigned for the interface.
-
port interface_port_number —Specify the port number for the interface.
For example, to enable the N15 interface allocate resources such as IP and port number. Once the interface is configured, the PCF-AMF traffic can pass through N15.
-
-
ips ip_address —Specify the IPv4 or IPv6 address that is assigned as a REST endpoint external IP address.
-
port port_number —Specify the port number for the REST endpoint.
-
http-connection-limit maximum_inbound_connection_count —Specify the maximum number of inbound HTTP connections that the REST endpoint server must accept. Default value is 200.
-
http-idle-connection-timeout-on-server-seconds idle_connection_timeout —Specify the idle connection timeout for REST connection where PCF is acting as server. Default value is 60 seconds.
If the value is less than or equal to 0, the default value of 60 seconds is used.
-
replicas replica_count —Specify the number of instances of the service-based interface.
-
inbound-request-timeout-ms inbound_timeout —Specify the timeout period after which the inbound request expires. You can configure a single inbound_timeout value for all the configured interfaces or the single interface.
-
outbound-request-timeout-ms outbound_timeout —Specify the timeout period after which the outbound request expires. You can configure a single outbound_timeout value for all the configured interfaces or the single interface.
-
repository repository_address —Specify a repository that the network interface optimizes.
-
tracing-service-name tracing_service —Specify the service that is used for tracing purpose.
-
uri-scheme uri_scheme —Specify the URI scheme as HTTP or HTTPs.
Note | If the configured IP address is not accessible, then PCF fails to connect with the other NFs and reports an error message in the service as "Failed to allocate IP for "pcf/udr-rest-ep": no available IPs". |