diff --git a/docs/01-5GC OMC 安装指南.md b/docs/01-5GC OMC 安装指南.md index e79e181..d19614c 100644 --- a/docs/01-5GC OMC 安装指南.md +++ b/docs/01-5GC OMC 安装指南.md @@ -19,7 +19,7 @@ WEB服务: nginx 1.14.0 (ubuntu) 操作系统环境：银河麒麟 kylin server v10 数据库环境：mariadb-10.3.35-1.p01.ky10.aarch64 WEB服务: nginx 1.16.1-11.p01.ky10.aarch64 -安装包名称格式：OMC 5GC16.1.1.arm64.rpm （其中，'5GC16.1.1'为版本号, 'arm64'为硬件平台名称） +安装包名称格式：OMC-5GC16.1.1.arm64.rpm （其中，'5GC16.1.1'为版本号, 'arm64'为硬件平台名称） ``` 注意事项： @@ -37,6 +37,8 @@ mariadb版本：mariadb-server-3:10.3.35-1.p01.ky10.aarch64 软件安装 +银河麒麟OS(CentOS) + ```bash # yum clean all # yum makecache @@ -117,10 +119,12 @@ MariaDB [(none)]> ``` -### 1.2 安装WEB服务 +### 1.2 安装WEB服务(可选) 注意：非第一次安装或者全新安装请跳过此步骤 +OMC Web服务可通过nginx代理进行访问，也可不需要代理进行访问 + WEB服务: nginx-1.16.1-11.p01.ky10.aarch64 * 软件安装 @@ -155,24 +159,7 @@ WEB服务: nginx-1.16.1-11.p01.ky10.aarch64 ### 2.1 安装OMC软件包 -* 导入签名证书 - -OMC软件包使用了RPM的GPG数字签名，第一次安装时需要导入签名证书, OMC的签名证书为RPM-GPG-KEY-OMCUSER - -```bash -# rpm --import RPM-GPG-KEY-OMCUSER -``` - -* 验证软件包完整性 - -显示"digests signatures OK"表示软件包是合法签名 - -```bash -# rpm -K OMC\ 5GC16.1.1.arm64.rpm -OMC-5GC16.1.1-20230628.ky10.aarch64.rpm: digests signatures OK -``` - -* 安装OMC软件包 +安装OMC软件包 ```bash # rpm -ivh OMC\ 5GC16.1.1.arm64.rpm @@ -189,8 +176,7 @@ omc │   ├── cpsshkey.sh │   ├── crontask │   ├── importdb.sh -│   ├── nbi_alarm -│   ├── ne-hosts +│   ├── nehosts │   ├── omcsvc.sh │   ├── restagent │   └── tables.txt @@ -200,7 +186,6 @@ omc │   ├── crontask.yaml │   ├── db │   ├── default -│   ├── nbi_alarm.json │   ├── restconf.yaml │   ├── schema │   └── tasks.yaml @@ -220,7 +205,7 @@ omc # ``` -### 2.2 修改nginx服务的OMC配置 +### 2.2 修改nginx服务的OMC配置(可选) 安装软件包成功后可以根据实际环境对nginx的OMC配置进行修改，前端Web的默认侦听端口是8888，除了侦听端口，其它不用修改 @@ -292,7 +277,8 @@ server { # firewall-cmd --add-port=6060/tcp --permanent # firewall-cmd --add-port=31232-31271/tcp --permanent # firewall-cmd --add-port=2222/tcp --permanent -# firewall-cmd --add-port=2152/udp --permanent +# firewall-cmd --add-port=6379/tcp --permanent +# firewall-cmd --add-port=2152/udp --permanent # firewall-cmd --reload ``` diff --git a/docs/05-5GC OMC restful intefaces v7.7.pdf b/docs/05-5GC OMC restful intefaces v0.77.pdf similarity index 100% rename from docs/05-5GC OMC restful intefaces v7.7.pdf rename to docs/05-5GC OMC restful intefaces v0.77.pdf diff --git a/docs/05-5GC OMC restful intefaces v0.78.pdf b/docs/05-5GC OMC restful intefaces v0.78.pdf new file mode 100644 index 0000000..7de49d3 Binary files /dev/null and b/docs/05-5GC OMC restful intefaces v0.78.pdf differ diff --git a/docs/05-5GC OMC restful intefaces v0.79.pdf b/docs/05-5GC OMC restful intefaces v0.79.pdf new file mode 100644 index 0000000..b24c189 Binary files /dev/null and b/docs/05-5GC OMC restful intefaces v0.79.pdf differ diff --git a/docs/05-5GC OMC restful intefaces.md b/docs/05-5GC OMC restful intefaces.md index 63d6b77..66915e0 100644 --- a/docs/05-5GC OMC restful intefaces.md +++ b/docs/05-5GC OMC restful intefaces.md @@ -13,7 +13,6 @@ ```Tips ** elementTypeValue=smf/amf/..查询的网元网元类型 ``` - * Method: GET @@ -1474,7 +1473,7 @@ Example: // SmfUEInfo SMF在线用户信息 type SubData struct { IMSI string `json:"imsi"` // SIM卡号 - MSISDN string `json:"msisdn""` + MSISDN string `json:"msisdn""` Amf string `json:"amf"` // Amf Status string `json:"status"` // 状态 Ki string `json:"ki"` // ki @@ -1504,11 +1503,10 @@ Example: #### 10.3.1 查询SMF在线用户数 - * Uri ```uri - /api/rest/ueManagement/v1/elementType/SMF/objectType/ueNum?neId={neId} + /api/rest/ueManagement/v1/elementType/smf/objectType/ueNum?neId={neId} ``` * Relations @@ -1542,19 +1540,20 @@ Example: #### 10.3.2 查询SMF在线用户 +说明：为了避免在线用户太多，SMF可做限制，如返回不超过100条 * Uri ```uri - /api/rest/ueManagement/v1/elementType/SMF/objectType/ueInfo?imsi={imsi}&msisdn={msisdn}&neId={neId} + /api/rest/ueManagement/v1/elementType/smf/objectType/ueInfo?imsi={imsi}&msisdn={msisdn}&neId={neId} ``` - * Relations OMC -> SMF * Params - * OMC-FE -> OMC-BE, neId={neId}, 指定IMS的neId - * OMC -> IMS, imsi={imsi} 或者 msisdn={msisdn} + * OMC-FE -> OMC-BE, neId={neId}, 指定SMF的neId + * OMC -> SMF, imsi={imsi} 或者 msisdn={msisdn}，可选，如果都不指定，则查询全部ueInfo + * Method GET @@ -1565,50 +1564,80 @@ Example: ```json // SmfUEInfo SMF在线用户信息 - type SmfUEInfo struct { - IMSI string `json:"imsi"` - MSISDN string `json:"msisdn"` - IPv4 []string `json:"ipv4"` - Dnn []string `json:"dnn"` - Tai []string `json:"tai"` - PduSessionID []int `json:"pduSessionID"` - IPv6 []string `json:"ipv6"` - SstSD []string `json:"sstSD"` - UpfN3IP []string `json:"upfN3IP"` - RanN3IP []string `json:"ranN3IP"` - Activetime []string `json:"activeTime"` + type SmfUEInfo []struct { + IMSI string `json:"imsi"` + MSISDN string `json:"msisdn"` + PduSessionInfo []struct { + PduSessionID int `json:"pduSessionID"` + IPv4 string `json:"ipv4"` + IPv6 string `json:"ipv6"` + Dnn string `json:"dnn"` + Tai string `json:"tai"` + SstSD string `json:"sstSD"` + UpfN3IP string `json:"upfN3IP"` + RanN3IP string `json:"ranN3IP"` + Activetime string `json:"activeTime"` + } `json:"pduSessionInfo"` } ``` ```json { - "data": - { - "imsi": "460000100000010", - "msisdn": "12307550010", - "...": "..." - } + "data": [ + { + "imsi": "460000100000010", + "msisdn": "12307550010", + "pduSessionInfo": [ + { + "pduSessionID": "1", + "ipv4": "172.16.5.5", + "...": "..." + }, + { + "pduSessionID": "2", + "ipv4": "172.16.5.6", + "...": "..." + } + ] + }, + { + "imsi": "460000100000238", + "msisdn": "12307550238", + "pduSessionInfo": [ + { + "pduSessionID": "3", + "ipv4": "172.16.5.7", + "...": "..." + }, + { + "pduSessionID": "4", + "ipv4": "172.16.5.8", + "...": "..." + } + ] + } + ] } ``` ### 10.4 IMS在线用户信息 -#### 10.4.1 查询IMS所有在线用户信息 +#### 10.4.1 查询IMS在线用户信息 -说明：为了避免在线用户太多，IMS可做限制，如返回不超过1000条 +说明：为了避免在线用户太多，IMS可做限制，如返回不超过100条 * Uri ```uri - /api/rest/ueManagement/v1/elementType/IMS/objectType/ueInfos?neId={neId} + /api/rest/ueManagement/v1/elementType/ims/objectType/ueInfo?imsi={imsi}&msisdn={msisdn}&neId={neId} ``` - * Relations OMC -> IMS * Params - OMC-FE -> OMC-BE, neId={neId}, 指定IMS的neId + * OMC-FE -> OMC-BE, neId={neId}, 指定IMS的neId + * OMC -> IMS, imsi={imsi} 或者 msisdn={msisdn}，可选，如果都不指定，则查询全部ueInfo * Method GET @@ -1642,81 +1671,32 @@ Example: }, { "imsi": "460000100000238", - "msisdn": "12307550010", + "msisdn": "12307550038", "impu": "sip:12307550238@ims.mnc000.mcc460.3gppnetwork.org", "barring": 0, "regState": 1, "activeTime": "2023-07-11 18:26:46" - } + } ] } ``` -#### 10.4.2 查询IMS单个在线用户信息 - -* Uri - - ```uri - /api/rest/ueManagement/v1/elementType/IMS/objectType/ueInfo?imsi={imsi}&msisdn={msisdn}&neId={neId} - ``` - -* Relations - - OMC -> IMS -* Params - - * OMC-FE -> OMC-BE, neId={neId}, 指定IMS的neId - * OMC -> IMS, imsi={imsi} 或者 msisdn={msisdn} -* Method - - GET -* Body - - NA -* Return - -```json - // ImsUEInfo IMS在线用户信息 - type ImsUEInfo struct { - IMSI string `json:"imsi"` - MSISDN string `json:"msisdn"` - IMPU string `json:"impu"` - Barring int `json:"barring"` - RegState int `json:"regState"` - Activetime string `json:"activeTime"` - } -``` - -```json - { - "data": - { - "imsi": "460000100000010", - "msisdn": "12307550010", - "impu": "sip:12307550010@ims.mnc000.mcc460.3gppnetwork.org", - "barring": 0, - "regState": 1, - "activeTime": "2023-07-11 18:26:46" - } - } -``` - ### 10.5 基站信息 -#### 10.5.1 查询某个AMF下的所有基站信息 +#### 10.5.1 查询某个AMF下的基站信息 * Uri ```uri - /api/rest/ueManagement/v1/elementType/AMF/objectType/nbInfos?neId={neId} + /api/rest/ueManagement/v1/elementType/amf/objectType/nbInfo?nbId={nbId}&neId={neId} ``` - * Relations OMC -> AMF * Params - OMC-FE -> OMC-BE, neId={neId}, 指定AMF的neId + * OMC-FE -> OMC-BE, neId={neId}, 指定AMF的neId + * OMC -> AMF, nbId={nbId}, 可选，如果不指定则查询全部基站信息 * Method GET @@ -1749,55 +1729,7 @@ Example: "name": "NB6002", "address": "192.168.1.246:36412", "ueNum": 6 - } + } ] } ``` - -#### 10.5.2 查询某个AMF下的基站信息 - -* Uri - - ```uri - /api/rest/ueManagement/v1/elementType/AMF/objectType/nbInfo/{id} - - ``` -* Relations - - OMC -> AMF -* Params - - OMC-FE -> OMC-BE, neId={neId}, 指定AMF的neId -* Method - - GET -* Body - - NA -* Return - -```json - // AmfNBInfo AMF的NodeB信息 - type AmfNBInfo struct { - ID string `json:"id"` //NodeB ID - Name string `json:"name"` // NodeB name - Address string `json:"address"` // 基站地址 - UENum int `jons:"ueNum"` // UE数量 - } -``` - -example: - -uri: /api/rest/ueManagement/v1/elementType/AMF/objectType/nbInfo/6001 - -```json - { - "data": - { - "id": "6001", - "name": "NB6001", - "address": "192.168.1.245:36412", - "ueNum": 2 - } - } -```