configure mobile-gateway profile pfcp command descriptions
pfcp
Syntax
- pfcp
Context
- [Tree] configure mobile-gateway profile pfcp
Description
This command enables the context to configure a PFCP profile.
pfcp-association-peer-list
Syntax
- [no] pfcp-association-peer-list profile-name
Context
- [Tree] configure mobile-gateway profile pfcp pfcp-association-peer-list
Description
This command creates a PFCP association peer list profile.
The no form of this command removes the profile from the configuration.
Parameters
- profile-name
- specifies the name for the profile, up to 32 characters
description
Syntax
- description long-description-string
- no description
Context
- [Tree] configure mobile-gateway profile pfcp pfcp-association-peer-list description
Description
This command associates a text string with a configuration context to help identify the content in the configuration file.
The no form of this command removes the description from the configuration.
Parameters
- long-description-string
- Specifies the description string, up to 80 characters, composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.
node-id
Syntax
- [no] node-id node-id
Context
- [Tree] configure mobile-gateway profile pfcp pfcp-association-peer-list node-id
Description
This multi-entry command configures a node ID string of the remote PFCP peer.
The no form of this command removes the specified node ID of the remote PFCP peer from the configuration.
Parameters
- node-id
- specifies the node ID of the remote PFCP peer, up to 31 characters
bfd-enable
Syntax
- [no] bfd-enable
Context
- [Tree] configure mobile-gateway profile pfcp pfcp-association-peer-list node-id bfd-enable
Description
This command enables the BFD association with the PFCP peer. The MAG-c uses the BFD state to determine the route convergence toward itself, before triggering a PFCP Association Setup Request toward the PFCP peers.
The no form of this command disables the BFD association with the PFCP peer.
- When this feature is used on the UP function, only a single IP address peer can be configured.
- To monitor the BFD status for PFCP interfaces, use the show router bfd session command with the appropriate router ID.
Default
no bfd-enable
pfcp-peer
Syntax
- [no] pfcp-peer ipv4 | ipv6
Context
- [Tree] configure mobile-gateway profile pfcp pfcp-association-peer-list pfcp-peer
Description
This multi-entry command configures the IPv4 or the IPv6 address of the remote PFCP peer.
The no form of this command removes the specified IPv4 or the IPv6 address of the remote PFCP peer from the configuration.
Parameters
- ipv4 | ipv6
- Specifies the peer’s IP address.
bfd-enable
Syntax
- [no] bfd-enable
Context
- [Tree] configure mobile-gateway profile pfcp pfcp-association-peer-list pfcp-peer bfd-enable
Description
This command enables the BFD association with the PFCP peer. The MAG-c uses the BFD state to determine route convergence toward itself, before triggering a PFCP Association Setup Request toward the PFCP peers.
The no form of this command disables the BFD association with the PFCP peer.
- When this feature is used on the UP function, only a single IP address peer can be configured.
- To monitor the BFD status for PFCP interfaces, use the show router bfd session command with the appropriate router ID.
Default
no bfd-enable
pfcp-profile
Syntax
- [no] pfcp-profile profile-name
Context
- [Tree] configure mobile-gateway profile pfcp pfcp-profile
Description
This command creates a PFCP profile.
The no form of this command removes the profile from the configuration.
Parameters
- profile-name
- specifies the name for the profile, up to 32 characters
association-retry-timer
Syntax
- association-retry-timer retry-time
- no association-retry-timer
Context
- [Tree] configure mobile-gateway profile pfcp pfcp-profile association-retry-timer
Description
This command configures the retry time between sending an association request in case of a PFCP interface path fault or if the initial association setup request fails.
Parameters
- retry-time
- specifies the time between retries for sending an association request, in seconds
audit-ip-dscp
Syntax
- audit-ip-dscp audit-ip-dscp-value
- no audit-ip-dscp
Context
- [Tree] configure mobile-gateway profile pfcp pfcp-profile audit-ip-dscp
Description
This command configures PFCP audit messages to use the DSCP value specified for audit-ip-dscp instead of the configured ip-dscp value.
The no form of this command causes PFCP audit messages to use the configured ip-dscp value.
Default
no audit-ip-dscp
Parameters
- audit-ip-dscp-value
- specifies the DSCP value sent in IPv4 and IPv6 PFCP audit messages
description
Syntax
- description long-description-string
- no description
Context
- [Tree] configure mobile-gateway profile pfcp pfcp-profile description
Description
This command associates a text string with a configuration context to help identify the content in the configuration file.
The no form of this command removes the description from the configuration.
Parameters
- long-description-string
- Specifies the description string, up to 80 characters, composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.
heart-beat
Syntax
- heart-beat [interval seconds] [retry-count retry-count-value] [timeout timeout-value]
- no heart-beat
Context
- [Tree] configure mobile-gateway profile pfcp pfcp-profile heart-beat
Description
This command configures the heartbeat attributes for the PFCP profile. When configured, heartbeats are sent when the PFCP node association has been successfully set up. The gateway sends a heartbeat message at the time specified in the interval keyword. If a PFCP Heartbeat Response is not received within the time specified in the timeout keyword, the gateway retries the timeout wait period, for the number of times specified in the retry-count keyword. If the gateway hears a PFCP Heartbeat Response from the remote end, it aborts the retry procedure and restarts the heartbeat interval timer for this peer. If no response is received before the end of the retry-timeout sequence, the PFCP peer is declared to be down.
The no form of this command turns off heartbeats and only responds to heartbeat requests received from the remote peer.
Parameters
- seconds
- specifies the heartbeat message interval
- retry-count-value
- specifies the number of retries
- timeout-value
- specifies the timeout interval, in seconds
ip-dscp
Syntax
- ip-dscp ip-dscp-value
- no ip-dscp
Context
- [Tree] configure mobile-gateway profile pfcp pfcp-profile ip-dscp
Description
This command configures the DSCP value in the IP Header used for PFCP signaling messages.
Parameters
- ip-dscp-value
- specifies the DSCP value
ip-ttl
Syntax
- ip-ttl ip-ttl-value
- no ip-ttl
Context
- [Tree] configure mobile-gateway profile pfcp pfcp-profile ip-ttl
Description
This command configures the IP TTL value used for PFCP signaling messages.
Parameters
- ip-ttl-value
- specifies the IP TTL value
message-retransmit
Syntax
- message-retransmit [timeout timeout] [timeout-msec timeout-msec] [retry-count retry-count-value]
- no message-retransmit
Context
- [Tree] configure mobile-gateway profile pfcp pfcp-profile message-retransmit
Description
This command configures the PFCP message retransmit timeout and retry count values. The retransmit timeout consists of T1 and N1 values. T1 is the time period that the PFCP waits before re-attempting the request message if there is no response to an initial request message. T1 can be configured either in seconds (timeout) or milliseconds (timeout-msec). N1 is the maximum number of times that the FPCP attempts to send a message. N1 can be configured by specifying the value of the retry-count keyword.
Parameters
- timeout
- specifies the time that the PFCP waits before resending a message if there is no response to an initial message, in seconds
- timeout-msec
- specifies the time that the PFCP waits before resending a message if there is no response to an initial message, in milliseconds
- retry-count-value
- specifies the number of times the PFCP attempts to send a message
path-restoration-time
Syntax
- path-restoration-time minutes
- no path-restoration-time
Context
- [Tree] configure mobile-gateway profile pfcp pfcp-profile path-restoration-time
Description
This command configures the path restoration time for the PFCP profile. A PFCP path is kept for the configured number of minutes after a path failure is detected. After the time expires, the path is considered down and all related sessions are removed. If the path recovers before the time expires, the system triggers an audit of all sessions related to that path.
The no form of this command disables the restoration time.
Default
no path-restoration-time
Parameters
- minutes
- specifies the number of minutes a path can wait for the restoration procedures
up-peer-list
Syntax
- [no] up-peer-list list-name
Context
- [Tree] configure mobile-gateway profile pfcp up-peer-list
Description
This command creates a list of BNG-UPs.
The no form of this command removes the list from the configuration.
Parameters
- list-name
- specifies the name for the list, up to 32 characters
description
Syntax
- description long-description-string
- no description
Context
- [Tree] configure mobile-gateway profile pfcp up-peer-list description
Description
This command associates a text string with a configuration context to help identify the content in the configuration file.
The no form of this command removes the description from the configuration.
Parameters
- long-description-string
- Specifies the description string, up to 80 characters, composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.
peer
Syntax
- [no] peer ipv4 | ipv6
Context
- [Tree] configure mobile-gateway profile pfcp up-peer-list peer
Description
This multi-entry command specifies the IPv4 or the IPv6 address of the user plane peer.
Parameters
- ipv4 | ipv6
- Specifies the user plane peer’s IP address.
apn
Syntax
- [no] apn apn-name
Context
- [Tree] configure mobile-gateway profile pfcp up-peer-list peer apn
Description
This multi-entry command specifies the APN names associated with the user plane peer. This is used when selecting an FWA-UP for FWA sessions.
Parameters
- apn-name
- specifies an APN name, up to 32 characters
upf-selection
Syntax
- upf-selection {true | false}
- no upf-selection
Context
- [Tree] configure mobile-gateway profile pfcp up-peer-list peer upf-selection
Description
This command configures a peer that is defined in the UP peer list to be selectable (upf-selection true) or not selectable (upf-selection false). This enables UPF selection to be suspended, to support on-the-fly configuration of the PFCP association list and UP peer list. When UPF selection is set to false, the CP function does not select the peer for any new FWA sessions, therefor enabling the peer to gracefully drain its existing sessions before it is taken out of service. While in this mode, the CP function continues to handle existing sessions and to run PFCP path management with the peer.
The no form of this command reverts to the default state; UPF selection is true (selectable).
- The default state for the UPF selection of a new peer depends on the
method used to add the peer to the UP peer list:
- If using CLI configuration through a console, UPF selection of a new peer is automatically false. This ensures that the peer is not selected for new PDN/PDU sessions until it has been fully added and is ready to be selected.
- If executing the admin save config file without UPF selection configured in it, UPF selection is automatically allowed (true).
- Changing the UPF selection is only allowed for existing peers. You must not add a new peer and set the UP selection in the same command execution (in a single line). Changing the UPF selection state is permitted after the peer has been added.
Default
no upf-selection