UNC

23.1.0
UNC Product Documentation

Issue Date 2023-04-15

HUAWEI TECHNOLOGIES CO., LTD.

Copyright © Huawei Technologies Co., Ltd. 2024. All rights reserved.
No part of this document may be reproduced or transmitted in any form or by any means without prior written
consent of Huawei Technologies Co., Ltd.

Trademarks and Permissions

and other Huawei trademarks are trademarks of Huawei Technologies Co., Ltd.
All other trademarks and trade names mentioned in this document are the property of their respective holders.

Notice
The purchased products, services and features are stipulated by the contract made between Huawei and the
customer. All or part of the products, services and features described in this document may not be within the
purchase scope or the usage scope. Unless otherwise specified in the contract, all statements, information, and
recommendations in this document are provided "AS IS" without warranties, guarantees or representations of
any kind, either express or implied.

The information in this document is subject to change without notice. Every effort has been made in the
preparation of this document to ensure accuracy of the contents, but all statements, information, and
recommendations in this document do not constitute a warranty of any kind, express or implied.

Huawei Technologies Co., Ltd.

Address: Huawei Industrial Base

Bantian, Longgang

Shenzhen 518129

People's Republic of China

Website: https://www.huawei.com

Email: [email protected]
UNC Product Documentation

Contents
Contents...........................................................................................................................................................................................................1
1 UCF Management.....................................................................................................................................................................................2
1.1 UCF Server IP .....................................................................................................................................................................................2
1.1.1 Add UCF Server IP(ADD UCFSVRIP)..................................................................................................................................2
1.1.2 Remove UCF Server IP(RMV UCFSVRIP) .........................................................................................................................5
1.1.3 Modify UCF Server IP(MOD UCFSVRIP) ..........................................................................................................................6
1.1.4 Query UCF Server IP(LST UCFSVRIP) .............................................................................................................................10
1.2 UCF IP ................................................................................................................................................................................................11
1.2.1 Add UCF IP Pool(ADD UCFIP)...........................................................................................................................................12
1.2.2 Remove UCF IP Pool(RMV UCFIP) ..................................................................................................................................15
1.2.3 Query UCF IP Pool(LST UCFIP).........................................................................................................................................15
1.3 UCF Server Link State...................................................................................................................................................................17
1.3.1 Display UCF Server Link Status(DSP UCFSVRLNKSTAT) .........................................................................................17
1.4 UCF Configuration Information ................................................................................................................................................20
1.4.1 Display the size of the ucfexec-pod disk space(DSP UCFDISKSIZE)....................................................................20
1.4.2 Set UCF File Management Specifications(SET UCFCONFIG).................................................................................21
1.4.3 List UCF File Management Specifications(LST UCFCONFIG) ................................................................................23
1.5 UCF Packets Info ............................................................................................................................................................................24
1.5.1 Display Packets Sent and Received by the UCF(DSP UCFPKTSTAT) ...................................................................25

2024-12-05 1
UNC Product Documentation

1 UCF Management
UCF Server IP

UCF IP

UCF Server Link State

UCF Configuration Information

UCF Packets Info

1.1 UCF Server IP

Add UCF Server IP(ADD UCFSVRIP)

Remove UCF Server IP(RMV UCFSVRIP)

Modify UCF Server IP(MOD UCFSVRIP)

Query UCF Server IP(LST UCFSVRIP)

1.1.1 Add UCF Server IP(ADD UCFSVRIP)

• Function

• Note

• Parameters

• Example

Function

FTP is an insecure protocol. Be careful when deciding to use it.

This command is used to add an access point IP address for a report server.

Note

• This command takes effect immediately.

• Ensure that the UCF service is online before running this command.

2024-12-05 2
UNC Product Documentation

• A maximum of 32 records of the SFTP type can be configured on report servers of the UCF.

• A maximum of 10 records of the FTP type can be configured on report servers of the UCF.

• A maximum of 10 access point IP addresses can be configured for each report server.

• Server Auth Mode cannot be set to PUBLICKEY in this version.

• A maximum of 60 data records can be added.

Required Permissions

G_1: administrator-level Command Group; G_2: operator-level Command Group

Parameters

ID Name Description

PROTOCOLTYPE PROTOCOL Mandatory Optional Description: This parameter is mandatory.

TYPE This parameter is used to specify the protocol type.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value:
TCP(TCP)
SFTP(SFTP)
FTP(FTP)
UDP(UDP)
Default value: This parameter is None.
Configuration notes: None

ACCESSNAME Access Name Mandatory Optional Description: This parameter is mandatory.

This parameter is used to specify the access name of UCF server.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value: String, a string of 0 to 32 characters.
Default value: This parameter is None.
Configuration notes: None

UCFSVRNAME UCF Server Mandatory Optional Description: This parameter is mandatory.

Name This parameter is used to specify the UCF Server Name.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value: String, a string of 0 to 32 characters.
Default value: This parameter is None.
Configuration notes: None

IPTYPE IP Type Mandatory Optional Description: This parameter is mandatory.

This parameter is used to specify the type of IP address.
Value source: Network data plan (configurations on other NFs need to be
considered).

2024-12-05 3
UNC Product Documentation

ID Name Description

Value:
IPv4(IPv4)
IPv6(IPv6)
Default value: This parameter is None.
Configuration notes: None

IPV4 UCF Server Mandatory Optional Description: This parameter is mandatory when
IPv4 Address IPTYPE is set to IPv4.
This parameter is used to specify the IPv4 address of UCF server.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value: IPv4 address.
Default value: This parameter is None.
Configuration notes:
It must be a class-A, B, or C IPv4 address and must not be 127.x.y.z,
240.x.y.z, or 255.0.0.0.
The IPv4 address must not be in the same network segment as any IPv4
address in the local IP address pool for reports.

IPV6 UCF Server Mandatory Optional Description: This parameter is mandatory when
IPv6 Address IPTYPE is set to IPv6.
This parameter is used to specify the IPv6 address of UCF server.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value: IPv6 address.
Default value: This parameter is None.
Configuration notes:
It must be a global unicast address and must not be ::, FFFF: FFFF: FFFF:
FFFF: FFFF: FFFF: FFFF: FFFF, loopback address (:: 1), link-local address
(FE80 :: / 10) or multicast address (FF00 :: / 8).
The IPv6 address must not be in the same network segment as any IPv6
address in the local IP address pool for reports.

SVRPORT UCF Server Mandatory Optional Description: This parameter is mandatory.

Port This parameter is used to specify the UCF server port number.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value: Integer, a number from 0 to 65534.
Default value: This parameter is None.
Configuration notes: None

USER Server User Mandatory Optional Description: This parameter is mandatory when
Name PROTOCOLTYPE is set to SFTP or FTP.
This parameter is used to specify the server user name.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value: String, a string of 0 to 64 characters.
Default value: This parameter is None.
Configuration notes: None

2024-12-05 4
UNC Product Documentation

ID Name Description

PWD Server User Mandatory Optional Description: This parameter is mandatory when
Password PROTOCOLTYPE is set to SFTP or FTP.
This parameter is used to specify the server user password.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value: Pwd, a number from 1 to 432.
Default value: This parameter is None.
Configuration notes: None

AUTHMODE Server Auth Mandatory Optional Description: This parameter is mandatory when
Mode PROTOCOLTYPE is set to SFTP or FTP.
This parameter is used to specify the server auth mode.
Value source: Local data plan (configurations on other NFs do not need to
be considered).
Value:
"NOAUTH(NOAUTH)": Key authentication is not required during key
negotiation, and user name and password authentication is required.
"PUBLICKEY(PUBLICKEY)": Key authentication is required during key
negotiation.
Default value: This parameter is None.
Configuration notes: None

SVRPATH Server Upload Mandatory Optional Description: This parameter is mandatory when
Path PROTOCOLTYPE is set to SFTP or FTP.
This parameter is used to specify the server upload path.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value: String, a string of 0 to 512 characters.
Default value: This parameter is None.
Configuration notes:
This parameter must be set to the complete name of FTP user path or the
subdirectory name. For example, if the FTP user path is /home/ftpuser/test,
set this parameter to /home/ftpuser/test or test.
The server upload path cannot contain special characters |;&$<> or
consecutive periods (..).

Example

To configure access point 1(ACCESS1) of UCF server 1(UCFSVR1), run the following command:

ADD UCFSVRIP: ACCESSNAME="ACCESS1", UCFSVRNAME="UCFSVR1", IPTYPE=IPv4, IPV4="10.180.211.254",

SVRPORT=10500,PROTOCOLTYPE=TCP;

1.1.2 Remove UCF Server IP(RMV UCFSVRIP)

• Function

• Note

2024-12-05 5
UNC Product Documentation

• Parameters

• Example

Function

This command is used to remove an access point IP address for a report server.

Note

• This command takes effect immediately.

• Ensure that the UCF service is online before running this command.

• If the only access point in the system is deleted, the report upload will be affected.

Required Permissions

G_1: administrator-level Command Group; G_2: operator-level Command Group

Parameters

ID Name Description

ACCESSNAME Access Mandatory Optional Description: This parameter is mandatory.

Name This parameter is used to specify the access name of UCF server.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value: String, a string of 0 to 32 characters.
Default value: This parameter is None.
Configuration notes: None

Example

Access name 1(ACCESS1) of UCF server 1(UCFSVR1) is no longer used and needs to be removed:

RMV UCFSVRIP: ACCESSNAME="ACCESS1";

1.1.3 Modify UCF Server IP(MOD UCFSVRIP)

• Function

• Note

• Parameters

• Example

2024-12-05 6
UNC Product Documentation

Function

FTP is an insecure protocol. Be careful when deciding to use it.

This command is used to modify an access point IP address for a report server.

Note

• This command takes effect immediately.

• Ensure that the UCF service is online before running this command.

• The IP address and port number must be configured at the same time.

• Server Auth Mode cannot be set to PUBLICKEY in this version.

Required Permissions

G_1: administrator-level Command Group; G_2: operator-level Command Group

Parameters

ID Name Description

ACCESSNAME Access Name Mandatory Optional Description: This parameter is mandatory.

This parameter is used to specify the access name of UCF server.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value: String, a string of 0 to 32 characters.
Default value: This parameter is None.
Configuration notes: None

UCFSVRNAME UCF Server Mandatory Optional Description: This parameter is optional.

Name This parameter is used to specify the UCF Server Name.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value: String, a string of 0 to 32 characters.
Default value: This parameter is None.
Configuration notes: None

IPTYPE IP Type Mandatory Optional Description: This parameter is optional.

This parameter is used to specify the type of IP address.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value:
IPv4(IPv4)
IPv6(IPv6)

2024-12-05 7
UNC Product Documentation

ID Name Description

Default value: This parameter is None.

Configuration notes: None

IPV6 UCF Server Mandatory Optional Description: This parameter is mandatory when
IPv6 Address IPTYPE is set to IPv6.
This parameter is used to specify the IPv6 address of UCF server.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value: IPv6 address.
Default value: This parameter is None.
Configuration notes:
It must be a global unicast address and must not be ::, FFFF: FFFF: FFFF:
FFFF: FFFF: FFFF: FFFF: FFFF, loopback address (:: 1), link-local address
(FE80 :: / 10) or multicast address (FF00 :: / 8).
The IPv6 address must not be in the same network segment as any IPv6
address in the local IP address pool for reports.

IPV4 UCF Server Mandatory Optional Description: This parameter is mandatory when
IPv4 Address IPTYPE is set to IPv4.
This parameter is used to specify the IPv4 address of UCF server.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value: IPv4 address.
Default value: This parameter is None.
Configuration notes:
It must be a class-A, B, or C IPv4 address and must not be 127.x.y.z,
240.x.y.z, or 255.0.0.0.
The IPv4 address must not be in the same network segment as any IPv4
address in the local IP address pool for reports.

SVRPORT UCF Server Mandatory Optional Description: This parameter is optional.

Port This parameter is used to specify the UCF server port number.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value: Integer, a number from 0 to 65534.
Default value: This parameter is None.
Configuration notes: None

PROTOCOLTYPE PROTOCOL Mandatory Optional Description: This parameter is optional.

TYPE This parameter is used to specify the protocol type.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value:
TCP(TCP)
SFTP(SFTP)
FTP(FTP)
UDP(UDP)
Default value: This parameter is None.
Configuration notes: None

2024-12-05 8
UNC Product Documentation

ID Name Description

USER Server User Mandatory Optional Description: This parameter is mandatory when
Name PROTOCOLTYPE is set to SFTP or FTP.
This parameter is used to specify the server user name.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value: String, a string of 0 to 64 characters.
Default value: This parameter is None.
Configuration notes: None

PWD Server User Mandatory Optional Description: This parameter is mandatory when
Password PROTOCOLTYPE is set to SFTP or FTP.
This parameter is used to specify the server user password.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value: Pwd, a number from 1 to 432.
Default value: This parameter is None.
Configuration notes: None

AUTHMODE Server Auth Mandatory Optional Description: This parameter is mandatory when
Mode PROTOCOLTYPE is set to SFTP or FTP.
This parameter is used to specify the server auth mode.
Value source: Local data plan (configurations on other NFs do not need to
be considered).
Value:
"NOAUTH(NOAUTH)": Key authentication is not required during key
negotiation, and user name and password authentication is required.
"PUBLICKEY(PUBLICKEY)": Key authentication is required during key
negotiation.
Default value: This parameter is None.
Configuration notes: None

SVRPATH Server Upload Mandatory Optional Description: This parameter is mandatory when
Path PROTOCOLTYPE is set to SFTP or FTP.
This parameter is used to specify the server upload path.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value: String, a string of 0 to 512 characters.
Default value: This parameter is None.
Configuration notes:
This parameter must be set to the complete name of FTP user path or the
subdirectory name. For example, if the FTP user path is /home/ftpuser/test,
set this parameter to /home/ftpuser/test or test.
The server upload path cannot contain special characters |;&$<> or
consecutive periods (..).

Example

2024-12-05 9
UNC Product Documentation

To change the IP address for access point 1(ACCESS1) of UCF server 1(UCFSVR1) from 10.180.211.254 to
10.180.211.253 and keep the default port number 10500 unchanged, run the following command:

MOD UCFSVRIP: ACCESSNAME="ACCESS1", UCFSVRNAME="UCFSVR1", IPTYPE=IPv4, IPV4=10.180.211.253,

SVRPORT=10500;

1.1.4 Query UCF Server IP(LST UCFSVRIP)

• Function

• Note

• Parameters

• Example

• Output Description

Function

This command is used to list access point IP addresses of a report server.

Note

Ensure that the UCF service is online before running this command.

Required Permissions

G_1: administrator-level Command Group; G_2: operator-level Command Group; G_3: user-level Command
Group

Parameters

ID Name Description

UCFSVRNAME UCF Server Mandatory Optional Description: This parameter is optional.

Name This parameter is used to specify the UCF Server Name.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value: String, a string of 0 to 32 characters.
Default value: This parameter is None.
Configuration notes: None

Example

To list access point IP addresses of report servers on the UCF, run the following command:

%%LST UCFSVRIP:;%%

2024-12-05 10
UNC Product Documentation

RETCODE = 0 Operation succeeded

The result is as follows:
------------------------
UCF Server Name = UCFSVR1
Access Name = ACCESS1
IP Type = IPv6
UCF Server IPv4 Address = 0.0.0.0
UCF Server IPv6 Address = fc00::5
UCF Server Port = 22
PROTOCOL TYPE = SFTP
Server User Name = root
Server User Password = *****
Server Auth Mode = NOAUTH
Server Upload Path = /paas/
(Number of results = 1)

--- END

Output Description

Output Item Description

UCF Server Name This parameter is used to specify the UCF Server Name.

Access Name This parameter is used to specify the access name of UCF server.

IP Type This parameter is used to specify the type of IP address.

UCF Server IPv4 Address This parameter is used to specify the IPv4 address of UCF server.

UCF Server IPv6 Address This parameter is used to specify the IPv6 address of UCF server.

UCF Server Port This parameter is used to specify the UCF server port number.

PROTOCOL TYPE This parameter is used to specify the protocol type.

Server User Name This parameter is used to specify the server user name.

Server User Password This parameter is used to specify the server user password.

Server Auth Mode This parameter is used to specify the server auth mode.

Server Upload Path This parameter is used to specify the server upload path.

1.2 UCF IP
Add UCF IP Pool(ADD UCFIP)

2024-12-05 11
UNC Product Documentation

Remove UCF IP Pool(RMV UCFIP)

Query UCF IP Pool(LST UCFIP)

1.2.1 Add UCF IP Pool(ADD UCFIP)

• Function

• Note

• Parameters

• Example

Function

This command is used to add a local IP address pool for reports on the UCF.

Note

• This command takes effect immediately.

• Ensure that the UCF service is online before running this command.

• A maximum of 64 port numbers can be configured for each report type.

• One UCF IP address record can be configured for each protocol. The UCF IP address records of FTP
and SFTP cannot be configured at the same time.

• When non-FTP protocols are used, the port range must be the same as the number of UCFEXEC
service instances.

• A maximum of 1000 data records can be added.

Required Permissions

G_1: administrator-level Command Group; G_2: operator-level Command Group

Parameters

ID Name Description

INDEX INDEX Mandatory Optional Description: This parameter is mandatory.

This parameter is used to specify the index number of records.
Value source: Local data plan (configurations on other NFs do not need to be
considered).
Value: Integer, a number from 0 to 4294967295.
Default value: This parameter is None.

2024-12-05 12
UNC Product Documentation

ID Name Description

Configuration notes: None

PROTOCOLTYPE PROTOCOL Mandatory Optional Description: This parameter is mandatory.

TYPE This parameter is used to specify the type of protocol used by UCF.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value:
TCP(TCP)
SFTP(SFTP)
FTP(FTP)
UDP(UDP)
Default value: This parameter is None.
Configuration notes:
FTP protocol is not a secure protocol and is not recommended.

IPTYPE IP TYPE Mandatory Optional Description: This parameter is mandatory.

This parameter is used to specify the type of IP address.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value:
IPv4(IPv4)
IPv6(IPv6)
Default value: This parameter is None.
Configuration notes: None

IPV4 IPv4 Address Mandatory Optional Description: This parameter is mandatory when IPTYPE
is set to IPv4.
This parameter is used to specify the local IPv4 address of UCF.
Value source: Local data plan (configurations on other NFs do not need to be
considered).
Value: IPv4 address.
Default value: This parameter is None.
Configuration notes:
It must be a class-A, B, or C IPv4 address and must not be 127.x.y.z, 240.x.y.z,
or 255.0.0.0.
The specified IPv4 address must not be in the same network segment as UCF
servers.

IPV6 IPv6 Address Mandatory Optional Description: This parameter is mandatory when IPTYPE
is set to IPv6.
This parameter is used to specify the local IPv6 address of UCF.
Value source: Local data plan (configurations on other NFs do not need to be
considered).
Value: IPv6 address.
Default value: This parameter is None.
Configuration notes:

2024-12-05 13
UNC Product Documentation

ID Name Description

It must be a global unicast address and must not be ::, FFFF: FFFF: FFFF:
FFFF: FFFF: FFFF: FFFF: FFFF, loopback address (:: 1), link-local address (FE80
:: / 10) or multicast address (FF00 :: / 8).

PORTSTART Port Start Mandatory Optional Description: This parameter is mandatory when
PROTOCOLTYPE is set to TCP, SFTP or UDP.
This parameter is used to specify the port start of the UCF report address.
Value source: Local data plan (configurations on other NFs do not need to be
considered).
Value: Integer, a number from 1025 to 65534.
Default value: This parameter is None.
Configuration notes: None

PORTEND Port End Mandatory Optional Description: This parameter is mandatory when
PROTOCOLTYPE is set to TCP, SFTP or UDP.
This parameter is used to specify the port end of the UCF report address.
Value source: Local data plan (configurations on other NFs do not need to be
considered).
Value: Integer, a number from 1025 to 65534.
Default value: This parameter is None.
Configuration notes:
Port End must not be smaller than Port Start.

VPNNAME VPN Name Mandatory Optional Description: This parameter is optional.

This parameter is used to specify the VPN name used in the report
transmission.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value: String, a string of 0 to 31 characters.
Default value: _public_
Configuration notes: None

DESC Description Mandatory Optional Description: This parameter is optional.

This parameter is used to specify the description information of the ip pool.
Value source: Local data plan (configurations on other NFs do not need to be
considered).
Value: String, a string of 0 to 32 characters.
Default value: This parameter is None.
Configuration notes: None

Example

To configure a local IP address pool for TCPs in the case of simple networking for the UCF, run the
following command:

ADD UCFIP: INDEX=1, PROTOCOLTYPE=TCP, IPTYPE=IPv4, IPV4="10.185.23.253", PORTSTART=6000, PORTEND=6002;

2024-12-05 14
UNC Product Documentation

1.2.2 Remove UCF IP Pool(RMV UCFIP)

• Function

• Note

• Parameters

• Example

Function

This command is used to remove a local IP address pool for reports on the UCF.

Note

• This command takes effect immediately.

• Ensure that the UCF service is online before running this command.

• After IP address pools for reports are deleted, reports cannot be sent to UCF servers.

Required Permissions

G_1: administrator-level Command Group; G_2: operator-level Command Group

Parameters

ID Name Description

INDEX INDEX Mandatory Optional Description: This parameter is mandatory.

This parameter is used to specify the index number of records.
Value source: Local data plan (configurations on other NFs do not need to be considered).
Value: Integer, a number from 0 to 4294967295.
Default value: This parameter is None.
Configuration notes: None

Example

To remove the IP address pool using index 3 , run the following command:

RMV UCFIP: INDEX=3;

1.2.3 Query UCF IP Pool(LST UCFIP)

• Function

• Note

2024-12-05 15
UNC Product Documentation

• Parameters

• Example

• Output Description

Function

This command is used to query local IP address pools for reports on the UCF.

Note

Ensure that the UCF service is online before running this command.

Required Permissions

G_1: administrator-level Command Group; G_2: operator-level Command Group; G_3: user-level Command
Group

Parameters

None

Example

To query local IP address pools for reports on the UCF, run the following command:

%%LST UCFIP:;%%
RETCODE = 0 Operation succeeded

The result is as follows

------------------------
INDEX = 1
PROTOCOL TYPE = SFTP
IP TYPE = IPv4
IPv4 Address = 10.181.23.253
IPv6 Address = ::
Port Start = 2000
Port End = 2001
VPN Name = _public_
Description = NULL
(Number of results = 1)

--- END

2024-12-05 16
UNC Product Documentation

Output Description

Output Item Description

INDEX This parameter is used to specify the index number of records.

PROTOCOL TYPE This parameter is used to specify the type of protocol used by UCF.

IP TYPE This parameter is used to specify the type of IP address.

IPv4 Address This parameter is used to specify the local IPv4 address of UCF.

IPv6 Address This parameter is used to specify the local IPv6 address of UCF.

Port Start This parameter is used to specify the port start of the UCF report address.

Port End This parameter is used to specify the port end of the UCF report address.

VPN Name This parameter is used to specify the VPN name used in the report transmission.

Description This parameter is used to specify the description information of the ip pool.

1.3 UCF Server Link State

Display UCF Server Link Status(DSP UCFSVRLNKSTAT)

1.3.1 Display UCF Server Link Status(DSP

UCFSVRLNKSTAT)
• Function

• Note

• Parameters

• Example

• Output Description

Function

This command is used to view the status of links between the UCF and the report server.

Note

Before running this command, ensure that the UCF service is online.

Required Permissions

2024-12-05 17
UNC Product Documentation

G_1: administrator-level Command Group; G_2: operator-level Command Group; G_3: user-level Command
Group

Parameters

ID Name Description

UCFSVRNAME UCF Server Mandatory Optional Description: This parameter is optional.

Name It specifies the name of a UCF server based on which the system displays the
link status. If it is not specified, the status of the links between the local end
and all peer UCF servers will be displayed.
Value source: Network data plan (configurations on other NFs need to be
considered).
Value: String, a string of 0 to 32 characters.
Default value: This parameter is None.
Configuration notes: None

PROTOCOLTYPE Protocol Mandatory Optional Description: This parameter is optional.

Type It specifies the protocol type based on which the system displays the link
status. If it is not specified, information about all types of protocols will be
displayed.
Value source: Local data plan (configurations on other NFs do not need to be
considered).
Value:
TCP(TCP)
SFTP(SFTP)
FTP(FTP)
UDP(UDP)
Default value: This parameter is None.
Configuration notes: None

Example

To display the status of links between the UCF and the report server, run the following command:

%%DSP UCFSVRLNKSTAT:;%%
RETCODE = 0 Operation succeeded

The result is as follows

------------------------
UCF Pod ID UCF Server Name Local IP Type Local IPv4 Local IPv6 Local Port Peer IP Type Peer IPv4 Address Peer
IPv6 Address Peer Port Protocol Type Link State

ucfexec-pod-1 UCFSVR IPv4 10.10.0.6 :: 6666 IPv4 10.10.0.66 :: 10500

TCP Up
ucfexec-pod-0 UCFSVR IPv4 10.10.0.6 :: 6667 IPv4 10.10.0.66 :: 10500
TCP Up

2024-12-05 18
UNC Product Documentation

(Number of results = 2)

--- END

Output Description

Output Item Description

UCF Pod ID It specifies the pod ID of the UCF service.

UCF Server It specifies the name of a UCF server based on which the system displays the link status. If it is
Name not specified, the status of the links between the local end and all peer UCF servers will be
displayed.

Local IP It specifies the local IP address type of the UCF.

Type Value:
IPv4(IPv4)
IPv6(IPv6)

Local IPv4 It specifies the local IPv4 address of the UCF.

Local IPv6 It specifies the local IPv6 address of the UCF.

Local Port It specifies the local port number of the UCF.

Peer IP Type It specifies the peer IP address type of a UCF server.

Value:
IPv4(IPv4)
IPv6(IPv6)

Peer IPv4 It specifies the peer IPv4 address of a UCF server.

Address

Peer IPv6 It specifies the peer IPv6 address of a UCF server.

Address

Peer Port It specifies the peer port number of a UCF server.

Protocol It specifies the protocol type based on which the system displays the link status. If it is not
Type specified, information about all types of protocols will be displayed.
Value:
TCP(TCP)
SFTP(SFTP)
FTP(FTP)
UDP(UDP)

Link State It specifies the link status.

Value:
UP(Up)

2024-12-05 19
UNC Product Documentation

Output Item Description

Down(Down)

1.4 UCF Configuration Information

Display the size of the ucfexec-pod disk space(DSP UCFDISKSIZE)

Set UCF File Management Specifications(SET UCFCONFIG)

List UCF File Management Specifications(LST UCFCONFIG)

1.4.1 Display the size of the ucfexec-pod disk space(DSP

UCFDISKSIZE)
• Function

• Note

• Parameters

• Example

• Output Description

Function

This command is used to query for the size of the ucfexec-pod disk space.

Note

Before running this command, ensure that the UCF services are online.

Required Permissions

G_1: administrator-level Command Group; G_2: operator-level Command Group; G_3: user-level Command
Group

Parameters

None

Example

To query for the disk space of the ucfexec-pod process, run the following command:

2024-12-05 20
UNC Product Documentation

%%DSP UCFDISKSIZE: ;%%

RETCODE = 0 Operation succeeded

The result is as follows

------------------------
UCF Pod Id Available UCF Disk Space (GB)

ucfexec-pod-0 64
ucfexec-pod-1 64
(Number of results = 2)

--- END

Output Description

Output Item Description

UCF Pod Id This parameter identifies the pod id of the UCF services.

Available UCF Disk Space This parameter indicates the total available disk space (GB)of the UCF
(GB) services.

1.4.2 Set UCF File Management Specifications(SET

UCFCONFIG)
• Function

• Note

• Parameters

• Example

Function

This is a high-risk command.If the size of cache files configured by running this command exceeds the available disk
space size, the service may be reset and cannot run properly.Therefore, run this command with caution and under the
guidance of Huawei technical support engineers.

This command is used to set UCF file management specifications when the TCP/SFTP/FTP protocol is used.

Note

• This command takes effect immediately.

2024-12-05 21
UNC Product Documentation

• Before running this command, ensure that the UCF service is online.

• When the write duration of a file is longer than the maximum write duration or the amount of data
to be written for a file is larger than the maximum write size, the file is compressed.

• After the system has been successfully deployed, initial values are generated for the parameters. The
following table lists the initial values:

CACHESTGSPACE MAXWRITETIME MAXWRITESIZE MAXKEEPDAYS

20 300 100 180

Required Permissions

G_1: administrator-level Command Group; G_2: operator-level Command Group

Parameters

ID Name Description

CACHESTGSPACE Cache File Mandatory Optional Description: This parameter is None.

Storage It specifies the maximum disk space (GB) for storing UCF local cache
Space(GB) files. The cache files of the SFTP, FTP, and TCP protocols share the disk
space.
Value source: Local data plan (configurations on other NFs do not need
to be considered).
Value: Integer, a number from 1 to 500.
Default value: This parameter is None.
Configuration notes:
If the value of this parameter is greater than the maximum disk size
that can be used by the UCF services, the maximum available disk size
will be used. If this value is less than the maximum disk size, this value
will be used.
To obtain the value of this parameter, run DSP UCFDISKSIZE. The value
of this parameter must be less than or equal to the minimum value of
Total disk space of UCF(GB) in the command output.

MAXWRITETIME Maximum Write Mandatory Optional Description: This parameter is None.

Time(second) It specifies the maximum duration (unit: second) of writing a local cache
file of the UCF. This parameter is valid only for cache files using the
SFTP and FTP protocols.
Value source: Local data plan (configurations on other NFs do not need
to be considered).
Value: Integer, a number from 5 to 1800.
Default value: This parameter is None.
Configuration notes: None

MAXWRITESIZE Maximum Write Mandatory Optional Description: This parameter is None.

Size(MB) It specifies the maximum write size (unit: MB) of a local cache file of the
UCF. This parameter is valid only for cache files using the SFTP and FTP
protocols. When the cache files use FTP, the value 50 takes effect if this

2024-12-05 22
UNC Product Documentation

ID Name Description

parameter is set to a value greater than 50. If this parameter is set to a

value less than 50, the actual value is used.
Value source: Local data plan (configurations on other NFs do not need
to be considered).
Value: Integer, a number from 10 to 500.
Default value: This parameter is None.
Configuration notes: None

MAXKEEPDAYS Maximum Mandatory Optional Description: This parameter is None.

Retention It specifies the maximum duration for storing locally cached files on the
Period(day) UCF, in days.
Value source: Local data plan (configurations on other NFs do not need
to be considered).
Value: Integer, a number from 7 to 1080.
Default value: This parameter is None.
Configuration notes: None

Example

To set UCF file management specifications, run the following command:

SET UCFCONFIG: CACHESTGSPACE=30, MAXWRITETIME=400, MAXWRITESIZE=200, MAXKEEPDAYS=7;

1.4.3 List UCF File Management Specifications(LST

UCFCONFIG)
• Function

• Note

• Parameters

• Example

• Output Description

Function

This command is used to view the information about UCF file management specifications.

Note

Before running this command, ensure that the UCF service is online.

Required Permissions

2024-12-05 23
UNC Product Documentation

G_1: administrator-level Command Group; G_2: operator-level Command Group; G_3: user-level Command
Group

Parameters

None

Example

To list UCF file management specifications, run the following command:

%%LST UCFCONFIG:;%%
RETCODE = 0 Operation succeeded

The result is as follows

------------------------
Cache File Storage Size(GB) = 20
Maximum Write Time(second) = 300
Maximum Write Size(MB) = 100
Maximum Retention Period(day) = 7
(Number of results = 1)

--- END

Output Description

Output Item Description

Cache File It specifies the maximum disk space (GB) for storing UCF local cache files. The cache files
Storage of the SFTP, FTP, and TCP protocols share the disk space.
Space(GB)

Maximum Write It specifies the maximum duration (unit: second) of writing a local cache file of the UCF.
Time(second) This parameter is valid only for cache files using the SFTP and FTP protocols.

Maximum Write It specifies the maximum write size (unit: MB) of a local cache file of the UCF. This
Size(MB) parameter is valid only for cache files using the SFTP and FTP protocols. When the cache
files use FTP, the value 50 takes effect if this parameter is set to a value greater than 50.
If this parameter is set to a value less than 50, the actual value is used.

Maximum It specifies the maximum duration for storing locally cached files on the UCF, in days.
Retention
Period(day)

1.5 UCF Packets Info

Display Packets Sent and Received by the UCF(DSP UCFPKTSTAT)

2024-12-05 24
UNC Product Documentation

1.5.1 Display Packets Sent and Received by the UCF(DSP

UCFPKTSTAT)
• Function

• Note

• Parameters

• Example

• Output Description

Function

This command is used to view the information about packets sent and received by the UCF.

Note

Before running this command, ensure that the UCF service is online.

Required Permissions

G_1: administrator-level Command Group; G_2: operator-level Command Group; G_3: user-level Command
Group

Parameters

ID Name Description

PODID UCF Pod Mandatory Optional Description: This parameter is optional.

ID It specifies the ID of a specific pod of the UCF based on which the system
displays the packet information. If it is not specified, packet information about
all pods of the UCF will be displayed. To obtain the value of this parameter, run
DSP POD:TYPE=byType, PODTYPE="ucfexec-pod", MEID=" ME ID".
Value source: Local data plan (configurations on other NFs do not need to be
considered).
Value: String, a string of 0 to 255 characters.
Default value: This parameter is None.
Configuration notes: None

PROTOCOLTYPE Protocol Mandatory Optional Description: This parameter is optional.

Type It specifies the protocol type based on which the system displays the packet
information. If it is not specified, information about all protocol types will be
displayed. To obtain the value of this parameter, run LST UCFSVRIP.
Value source: Local data plan (configurations on other NFs do not need to be
considered).
Value:
TCP(TCP)

2024-12-05 25
UNC Product Documentation

ID Name Description

SFTP(SFTP)
FTP(FTP)
UDP(UDP)
Default value: This parameter is None.
Configuration notes: None

ACCESSNAME Access Mandatory Optional Description: This parameter is optional.

Point It specifies the name of an access point based on which the system displays the
Name packet information. If it is not specified, information about all access points will
be displayed. To obtain the value of this parameter, run LST UCFSVRIP.
Value source: Local data plan (configurations on other NFs do not need to be
considered).
Value: String, a string of 0 to 32 characters.
Default value: This parameter is None.
Configuration notes: None

Example

To display the information about packets sent from the UCF to an access point, run the following
command:

%%DSP UCFPKTSTAT:;%%
RETCODE = 0 Operation succeeded

The result is as follows

------------------------
UCF Pod ID Protocol Type Access Point Name Number of Received Packets Number of Packets Discarded Due to Flow
Control Number of Successfully Sent Packets Number of Unsuccessfully Sent Packets Number of Successfully Sent Files
Number of Unsuccessfully Sent Files Number of Files Deleted Due to Aging Number of Files Sent from Non-primary
Instances to Primary Instance

ucfexec-pod-1 TCP ACCESS1 5120 0 5120

0 0 0 0 0
ucfexec-pod-0 TCP ACCESS1 5120 0 5120
0 0 0 0 0
(Number of results = 2)

--- END

Output Description

2024-12-05 26
UNC Product Documentation

Output Item Description

UCF Pod ID It specifies the ID of a specific pod of the UCF based on which the system displays
the packet information. If it is not specified, packet information about all pods of
the UCF will be displayed. To obtain the value of this parameter, run DSP
POD:TYPE=byType, PODTYPE="ucfexec-pod", MEID=" ME ID".

Protocol Type It specifies the protocol type based on which the system displays the packet
information. If it is not specified, information about all protocol types will be
displayed. To obtain the value of this parameter, run LST UCFSVRIP.
Value:
TCP(TCP)
SFTP(SFTP)
FTP(FTP)
UDP(UDP)

Access Point Name It specifies the name of an access point based on which the system displays the
packet information. If it is not specified, information about all access points will
be displayed. To obtain the value of this parameter, run LST UCFSVRIP.

Number of Received It specifies the total number of packets received by a single UCFEXEC service
Packets instance, with access points not restricted (unit: number).

Number of Packets It specifies the total number of packets discarded by a single UCFEXEC service
Discarded Due to Flow instance due to flow control, with access points not restricted (unit: number).
Control

Number of Successfully It specifies the number of packets successfully sent by the UCF to an access point
Sent Packets (unit: number).

Number of Unsuccessfully It specifies the number of packets that fail to be sent by the UCF to an access
Sent Packets point (unit: number).

Number of Successfully It specifies the number of files successfully sent by the UCF to an access point
Sent Files using FTP or SFTP (unit: number).

Number of Unsuccessfully It specifies the number of files that fail to be sent by the UCF to an access point
Sent Files using SFTP (unit: number).

Number of Files Deleted It specifies the number of files deleted due to aging by a single UCFEXEC service
Due to Aging instance using FTP or SFTP, with access points not restricted (unit: number).

Number of Files Sent from It specifies the number of files sent from a non-primary UCFEXEC service instance
Non-primary Instances to to the primary UCFEXEC service instance when FTP is used (unit: number).
Primary Instance

2024-12-05 27