SIS 3.2 :: SIS Administration Guide :: Getting and Setting the SIP Originating Macro

To get or set the SIP originating macro, use the following sis-console command, Ant task, or related MBean operation:

About the SIP Originating Macro

Unlike IN protocols, SIP has no standard for determining whether an initial request is as an "originating" or "terminating" trigger. This is network-specific.

The SIS needs to know whether the request is originating or terminating when it determines the trigger address tracing selectors for an initial request. The SIS uses a user-defined macro to do this for SIP.

This macro is specified using the commands below. It must return true if an initial request is an originating trigger. If the macro returns false, the SIS treats the request as if it was a terminating trigger. If no originating macro is configured, the SIS treats all initial requests as originating, for the purposes of trigger address tracing.

This is a SIS feature for SIP.

Console commands
- getSIPOriginatingMacro
- setSIPOriginatingMacro
Ant task
- setSIPOriginatingMacro
MBean operations
- getOriginatingMacro
- setOriginatingMacro

Console commands

`getSIPOriginatingMacro`

Command	getsiporiginatingmacro <ra-entity> Get the currently configured SIP originating macro.
Example	$ sis-console getsiporiginatingmacro sipsis Current originating macro is MacroID[name=IsOriginating,vendor=OpenCloud,version=1.0]

Command

getsiporiginatingmacro <ra-entity>
    Get the currently configured SIP originating macro.

Example

$ sis-console getsiporiginatingmacro sipsis
Current originating macro is MacroID[name=IsOriginating,vendor=OpenCloud,version=1.0]

`setSIPOriginatingMacro`

Command	setsiporiginatingmacro <ra-entity> <macro-id> Set the macro used by trigger address tracing to determine if an initial SIP request is originating or terminating.
Example	$ sis-console setsiporiginatingmacro sipsis name=IsOriginating,vendor=OpenCloud,version=1.0 Originating macro set to MacroID[name=IsOriginating,vendor=OpenCloud,version=1.0]

Command

setsiporiginatingmacro <ra-entity> <macro-id>
    Set the macro used by trigger address tracing to determine if an initial
    SIP request is originating or terminating.

Example

$ sis-console setsiporiginatingmacro sipsis name=IsOriginating,vendor=OpenCloud,version=1.0
Originating macro set to MacroID[name=IsOriginating,vendor=OpenCloud,version=1.0]

Ant task

`setSIPOriginatingMacro`

Task	<setsiporiginatingmacro> <macro name="..." vendor="..." version="..."/> </setsiporiginatingmacro>
Example	<sis-sip-management> ... <setsiporiginatingmacro> <macro name="Originating" vendor="XYZ" version="1.1"/> </setsiporiginatingmacro> </sis-sip-management>

Task

<setsiporiginatingmacro>
    <macro name="..." vendor="..." version="..."/>
</setsiporiginatingmacro>

Example

<sis-sip-management>
    ...
    <setsiporiginatingmacro>
        <macro name="Originating" vendor="XYZ" version="1.1"/>
    </setsiporiginatingmacro>
</sis-sip-management>

MBean operations

MBean	`SIP Configuration Management`

MBean

SIP Configuration Management

`getOriginatingMacro`

Operation	public MacroID getOriginatingMacro() throws ManagementException;

Operation

public MacroID getOriginatingMacro() throws ManagementException;

`setOriginatingMacro`

Operation	public void setOriginatingMacro(MacroID id) throws ManagementException;

Operation

public void setOriginatingMacro(MacroID id) throws ManagementException;

Previous page Next page