mi_http Module

Edited by

Ovidiu Sas

Revision History
Revision $Rev: 8688 $$Date$

Table of Contents

1. Admin Guide
1.1. Overview
1.2. To-do
1.3. Dependencies
1.3.1. OpenSIPS Modules
1.4. Exported Parameters
1.4.1. mi_http_root(string)
1.4.2. mi_http_method(integer)
1.5. Exported Functions
1.6. Known issues

List of Examples

1.1. Set mi_http_root parameter
1.2. Set mi_http_method parameter

Chapter 1. Admin Guide

1.1. Overview

This module provides an HTTP transport layer implementation for OpenSIPS's Management Interface.

1.2. To-do

Features to be added in the future:

  • possibility to authenticate connections.

1.3. Dependencies

1.3.1. OpenSIPS Modules

The following modules must be loaded before this module:

  • httpd module.

1.4. Exported Parameters

1.4.1. mi_http_root(string)

Specifies the root path for mi http requests. The link to the mi web interface must be constructed using the following patern: http://[opensips_IP]:[opensips_mi_port]/[mi_http_root]

The default value is "mi".

Example 1.1. Set mi_http_root parameter

modparam("mi_http", "mi_http_root", "opensips_mi")

1.4.2. mi_http_method(integer)

Specifies the HTTP request method to be used:

  • 0 - use GET HTTP request

  • 1 - use POST HTTP request

The default value is 0.

Example 1.2. Set mi_http_method parameter

modparam("mi_http", "mi_http_method", 1)

1.5. Exported Functions

No function exported to be used from configuration file.

1.6. Known issues

Commands with large responses (like ul_dump) will fail if the configured size of the httpd buffer is to small (or if there isn't enough pkg memory configured).

Future realeases of the httpd and mi_httpd modules will address this issue.