Configuring the APN Interface Resource on the Wireless Network

Function

This interface is used to configure the APN interface resource on the wireless network.

Syntax

Operation type: PATCH

URL: https://device_ip/redfish/v1/Systems/LTE/ConfigInfo

Request header:

X-Auth-Token: auth_value

Request message body:

{
    "apn_name": apnname,
    "apn_user": apnuser,
    "apn_passwd": apnpasswd,
    "auth_type":authtype
}

Request Parameters

**Table 1** Request parameters
Parameter	Mandatory/Optional	Description	Value
apn_name	Mandatory	APN name used for wireless network dial-up. This parameter cannot be left blank.	The value is a string of a maximum of 39 characters, including uppercase and lowercase letters (a to z and A to Z), digits (0 to 9), and other characters (_-.@).
apn_user	Optional	APN user name used for wireless network dial-up. This parameter can be left blank. The apn_user and apn_passwd fields must be both empty or not empty. Set this parameter based on the actual information provided by the carrier.	The value is a string of a maximum of 64 characters, including uppercase and lowercase letters (a to z and A to Z), digits (0 to 9), and other characters (-_.@).
apn_passwd	Optional	APN password used for wireless network dial-up. This parameter can be left blank. The apn_user and apn_passwd fields must be both empty or not empty. Set this parameter based on the actual information provided by the carrier.	The value is a string of 1 to 64 characters, including digits (0 to 9), uppercase and lowercase letters (a to z and A to Z), special characters (~`!?, .:;-_'"(){}[]/<>@#^&$%*+\|\=), and spaces.
auth_type	Mandatory	Authentication type.	Character string. Value: 0: None 1: PAP 2: CHAP 3: PAP or CHAP NOTE: The value of auth_type supported by the 4G module can be 0, 1, or 2. The value of auth_type supported by the 5G module can be 0, 1, 2, or 3.

Usage Guidelines

The API is developed by default. The function is adapted based on the wireless NIC.

Example

Request:

PATCH https://10.10.10.10/redfish/v1/Systems/LTE/ConfigInfo

Request header:

X-Auth-Token: auth_value

Request message body:

{
    "apn_name": "apnname",
    "apn_user": "apnuser",
    "apn_passwd": "apnpasswd",
    "auth_type": "1"
}

Response:

{
    "error": {
    "code": "Base.1.0.Success",
    "message": "Operation success. See ExtendedInfo for more information.",
    "@Message.ExtendedInfo": [
        {
          "@odata.type": "#MessageRegistry.v1_0_0.MessageRegistry",
          "Description": "Indicates that no error has occurred.",
          "Message": "Config LTE APN successfully.",
          "Severity": "OK",
          "NumberOfArgs": null,
          "ParamTypes": null,
          "Resolution": "None"
        }
      ]
    }
}

Response code: 202

Output Description

**Table 2** Operation output description
Field	Type	Description
code	Character string	A string indicating the specific message ID in the message registry.
message	Character string	A readable message corresponding to a message in the message registry.
@odata.type	Character string	OData description of a message resource.
Description	Character string	Detailed description of a message resource.
Message	Character string	Detailed information about a message resource.
Severity	Character string	Severity. OK Warning Critical
NumberOfArgs	Number	Number of parameters in a message description.
ParamTypes	Array	Parameter type list.
Resolution	Character string	Event handling suggestions.

Parent topic: Network Management